Proffy is a complete application built on Node.js, ReactJs and React Native

About The Project   |    Backend Technologies   |    Backend Getting Started   |    How To Contribute   |    Backend License

About The Project   |    Frontend Technologies   |    Frontend Getting Started   |    How To Contribute   |    Frontend License

About The Project   |    Mobile Technologies   |    Mobile Getting Started   |    How To Contribute   |    Mobile License

👨🏻‍💻 About the project

Proffy is an online study platform, with the aim of connecting education professionals with people interested in learning new subjects. In the web version, the education professional can register to teach classes and/or search for other professionals in order to learn something new, while in the mobile version the user can search for professionals through search filters according to their needs.

This is a project developed during the #NextLevelWeek2. An online programming event given by Rocketseat that shows how to use the JavaScript / TypeScript stack, on the backend with Nodejs, on the frontend with ReactJS and on mobile using the Expo.

🚀 Backend Technologies

Technologies that I used to develop this api

• Node.js
• TypeScript
• Cors
• Express
• Knex
• Sqlite3
• VS Code with EditorConfig and Prettier RC

💻 Backend getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/proffy.git

$ cd proffy

$ cd server

Follow the steps below

# Install the dependencies
$ yarn

# Run the API
$ yarn start

🤔 How to contribute backend

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/proffy.git

$ cd proffy

$ cd server

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Backend License

This project is under the MIT license. See the LICENSE for more information.

🚀 Frontend Technologies

Technologies that I used to develop this frontend app

• ReactJS
• TypeScript
• Axios
• React Router v5
• VS Code with EditorConfig and Prettier RC

💻 Frontend getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/proffy.git

$ cd proffy

$ cd web

Follow the steps below

# Install the dependencies
$ yarn

# Run the web app
$ yarn start

🤔 How to contribute frontend

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/proffy.git

$ cd proffy

$ cd web

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Frontend License

This project is under the MIT license. See the LICENSE for more information.

🚀 Mobile Technologies

Technologies that I used to develop this mobile app

• Expo
• React-Native
• Axios
• @expo-google-fonts
• @react-native-community/async-storage
• @react-navigation/bottom-tabs
• @react-navigation/navigator
• React-Navigation-Stack
• VS Code with EditorConfig and Prettier RC

💻 Mobile getting started

Requirements

• Node.js
• Yarn or npm
• Expo

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/proffy.git

$ cd proffy

$ cd mobile

Follow the steps below

# Install the dependencies
$ yarn

# Run the mobile app
$ yarn start

Install the app on a physical phone

1. Go to your app store, look for the app called Expo, and install it on your device.

2. With the app installed, open it and click on Scan QR Code, point the camera phone to the QR code shown on the page that opened after executing the command yarn start and ready, the app will load and be ready for use.

🤔 How to contribute mobile

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/proffy.git

$ cd proffy

$ cd mobile

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Mobile License

This project is under the MIT license. See the LICENSE for more information.

---

Made with ♥ by Elton Lazzarin 👋 Get in touch!