gabrielpulga / nlw2-proffy

Proffy is a responsive website and app to connect students to teachers that was made during Rocketseat 2nd Next Level Week.

🚀 Project made to connect students to teachers.

📌 Table of contents

• Technologies
• How to run
• ToDo
• License

💻 Technologies

This project was made using the following technologies:

• NodeJs
• Typescript
• React
• React Native
• Expo

👷 How to run

💻 Downloading project

# Clone repository into your machine
$ git clone https://github.com/gabrielpulga/nlw2-proffy.git

💻 Running project on a web browser

Front-end

# Go to project's web folder
$ cd web

# Install dependencies
$ yarn install or npm install

# Run application
$ yarn start or npm run start

Front-end UX available at http://localhost:3000/.

Back-end

# Go to project's server folder
$ cd server

# Install dependencies
$ yarn install or npm install

# Run application
$ yarn start or npm run start

# Make migrations
$ yarn knex:migrate

API available to be tested on http://localhost:3333/.

📱 Running project on mobile

To run the project on mobile you need a cellphone with the expo app instaled or an android/ios emulator.

# Go to project's mobile folder
$ cd mobile/

# Install dependencies
$ yarn install  or npm install

# Run application
$ yarn start or npm run start

📝 ToDo

• Splash screen
• User Login -> Remember me
• User Logout
• Succeed Screen
• User auth -> Web and Mobile
• Password recovery
• Teacher profile
• Deploy

📕 License

Released in 2020.

Made with passion by Gabriel Pulga 🚀. This project is under the MIT license.

Give it a ⭐️ if this project helped you!