🚀 Proffy Project developed during the 2nd edition of Rocketseat's NLW.

📌 Table of Contents

• About
• Technologies
• How to run
• How to Contribute

🔖 About

The Proffy is a project made to connect teachers to students.

🚀 Technologies

The project was developed using the following technologies

• TypeScript
• Knex
• Node.js
• ReactJS
• React Native
• Expo

Web Screenshot

Mobile Screenshot

🔥 How to run

❗ Back-End (API server)

Clone the project on your computer. To install the dependencies and run the Server (development mode) execute:

cd server
yarn install // npm install
yarn dev // npm dev

❗ Front-End (Web Application)

To start ** Frontend ** of React use the commands:

cd web
yarn install // npm install
yarn start // npm start

After the process is over, the localhost: 3000 page containing the developed project will automatically open in your browser.

❗ Mobile

To look the mobile application with React Native, first you need to put the server's IP (or computer's IP) in the src/services/api.js file and then execute the commands:

# It is NOT necessary to execute a bottom line if you already have Expo (CLI) installed
global yarn add install expo-cli // npm install -g expo-cli
cd mobile
yarn install // npm installation
yarn start // npm start

♻️ How to contribute

• First, leave a ⭐ if you like it!
• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature
• Commit your changes: git commit -m 'feat: My new feature'
• Push your branch: git push origin my-feature

📝 License

This project is under the MIT license. See the licence page for more details.

---

Made with 💜 by Guilherme Orcezi