README.md

proffy-NLW

📓 Educational platform to connect teachers and students

💻 Technologies

This project was made using the follow technologies:

• Typescript
• React
• Expo
• Express

🚀 Features

• Website to sign up teachers and students.
• App to connect teachers and students.

👷 How to run

# Clone Repository
$ git clone https://github.com/RafaelGoulartB/Proffy.git

📦 Run API

# Go to server folder
$ cd Proffy/server

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Access API at http://localhost:3333/

💻 Run Web Project

# Go to web folder
$ cd Proffy/web

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Go to http://localhost:3000/ to see the result.

📱 Run Mobile Project

To run the mobile project you need a cellphone with the app of expo instaled or a emulator android/ios.
After, fork this repository and clone to your machine. Inside of the project's folder run the following commands:

# Go to mobile folder
$ cd Proffy/mobile

# Install Dependencies
$ yarn install

# Run Aplication
$ yarn start

Aferter read the QRCode with the app of expo or run on emulator.