/proffy

Primary LanguageTypeScriptMIT LicenseMIT

๐Ÿš€ 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

๐Ÿ“ฅ Layout available for download at:

Direct Download Direct Download

Web Screenshot

Mobile Screenshot

๐Ÿ’ป Technologies

This project was made using the follow technologies:

๐Ÿš€ 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!