README.md

🚀 Project made to connect teachers to students, made in Next Level Week #2 @Rocketseat

English · Portuguese

_{The NLW #2 project. Built with ❤︎ by Palloma Gualter and}

📌 Table of Contents

• Technologies
• Features
• How to Run
• Contributing
• License

📥 Layout available for download at:

Web Screenshot

Mobile Screenshot

💻 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/PallomaGualter/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.

📕 License

Released in 2021 📕 License

Made with love by Palloma Gualter 🚀. This project is under the MIT license.

Give a ⭐️ if this project helped you!