🚀 A web app and mobile application made to connect teachers to students via search terms

📌 Table of Contents

• Technologies
• Features
• How to Run
• Found a bug? Missing a specific feature?
• License

---

Web

---

Mobile

💻 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/vcwild/proffy.git

📦 Run API

# Go to server folder
$ cd ./server

# Install Dependencies
$ npm install

# Run Aplication
$ npm start

Access API at http://localhost:3333/

💻 Run Web

# Go to web folder
$ cd "./web"

# Install Dependencies
$ npm install

# Run Aplication
$ npm start

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

📱 Run Mobile

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 "./mobile"

# Install Dependencies
$ npm install

# Run Aplication
$ npm start

Read the QR Code with expo or run via emulator.

🐛 Issues

Found a bug? Feel free to post an issue with title and description.

📥 Download the Layout

📕 License

Released in 2020 📕 License

This project is under the MIT license.