Gust4voSales / Proffy-NLW-02

Proffy is a platform that connects students and teachers. It's an open source project developed during the second Next Level Week edition by @Rocketseat

Proffy is a platform that connects students and teachers. It's an open source project developed during the second Next Level Week edition by @Rocketseat

README em Português

WEB screenshots

MOBILE screenshots

📜 About

This project aims to be a bridge that connects students and teachers through a platform. Teachers can register to the website adding their informations among with their contact. Students can filter teachers by hour, day and subject. This repo contaims the code from both the frontend and the backend API that serves the web and mobile applications.

💻 Techs

• NodeJS
• Typescript
• Express
• Knex.js
• React
• React Native
• Expo

🛠 Getting started

First of all, clone this repo running on your terminal with git clone https://github.com/Gust4voSales/Proffy-NLW-02.git

• Running the backend

1. Run yarn inside server folder to install all dependecies
2. Then yarn knex:migrate to run the database migrations and create the tables
3. Finally yarn start to run the api
4. Optionally,
   
   

• Running the web project

1. Run yarn inside web folder to install all dependecies
2. yarn start to run the web aplication

• Running the mobile project

1. Run yarn inside mobile folder to install all dependecies
2. yarn start to run the mobile aplication (expo is required in your machine)
3. Change the baseURL link in the file: src/services/api.ts (Add your own IP address, you can check it in the Expo web console that opens once you run the app)