IcaroApoloBR / Proffy

The platform that connects teachers and students for a better online study experience.

Next Level Week #2 by Rocketseat

📌 Table of Contents

• Web Screenshot
• Mobile Screenshot
• Technologies
• How to Run
• License

Web Screenshot

Mobile Screenshot

🚀 Technologies

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

👷 How To Run

• Pre-requisites

  • It is necessary to have Node.js installed.
  • It is necessary to have Git installed and configured.
  • It is necessary to have a package manager Yarn.
  • Finally, it is essential to have Expo installed globally on the machine.

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

📦 Run API

# Go to server folder
$ cd proffy/server

# Install Dependencies
$ yarn install
# Setting up the database and creating the tables.
$ yarn knex:migrate

# 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

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

📝 License

This project is under the MIT license. See the archive LICENSE for more details.