nlw-2-proffy

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

English · Portuguese

_{The NLW #2 project. Built with ❤︎ by wfTom}

About   |    Technologies   |    Features   |    How to run   |    License

🔖 About

The Proffy is a Web and Mobile application designed to assist in the connection between students and teachers. So, this application offers teachers the possibility to register classes, being able to add information such as the discipline, cost and timetable and students the possibility to search for classes indexed.

This project was conceived thinking of the 6 of August, where the National Day of Education Professionals.

This application was carried out during the Next Level Week # 2, a project by Rocketseat.

Web Screenshot

Mobile Screenshot

💻 Technologies

This project was made using the follow technologies:

• Typescript
• Node.js
• Express
• Axios
• ReactJS
• Expo
• React Native

🚀 Funcionalidades

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

💥 How to run

• Requirements

  • It is necessary to have Node.js installed on the computer.
  • It is optional to have Git installed and configured on the computer, but it is better to have.
  • Also, it is necessary to have a package manager be the NPM or Yarn.
  • Finally, it is essential to have Expo installed general shape on the machine.

# Clone Repository
$ git clone https://github.com/wfTom/nlw-2-proffy.git

📦 Run API

# Go to server folder
$ cd nlw-2-proffy/server

# Install Dependencies
$ yarn install

# Run Application
$ yarn start

Access API at http://localhost:3333/

💻 Run Web Project

# Go to web folder
$ cd nlw-2-proffy/web

# Install Dependencies
$ yarn install

# Run Application
$ 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 nlw-2-proffy/mobile

# Install Dependencies
$ yarn install

# Run Application
$ yarn start

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

📕 License

Released in 2021 📕 License

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

Give a ⭐️ if this project helped you!