Proffy

🏁 Finished. 🏁

(for now)

Proffy is a project developed at the NLW(next level week) 2 program of Rocketseat company using Node.js, React, and React Native.

Goal • Layout • Features • Requirements • Running project • Technologies • Author

🎯 Goal

Proffy is a project developed to help teachers from several subjects connect with students who want to learn them.

🎨 Layout

🕸 Web

📱 Mobile

🎩 Features

Class

• Search for classes by weekday, subject, and time
• Create class

Connection

• List the number of connections between the teacher and the student
• Create a connection between teacher and student

Student(only on mobile)

• Add teacher to list of favorites
• Remove teacher from list of favorites
• List favorite teachers

👨🏻‍🔬 Requirements

Before we begin, you'll need to have the following dependencies installed: Git, Node.js and Yarn. Besides, it would be great if you have a code editor to work on this project, such as VSCode.

🏃‍♀️ Runing project 🏃‍♂️

⚠️ Attention ⚠️

To run the mobile app It's important that you change the 'baseURL' value to your IP address in this file.

🕵️‍♀️ Hint 🕵️‍♂️

You can also access the Insomnia file below to check for API features and how to use them.

#### Start sever ####

# Clone the repo
$ git clone <https://github.com/thalessarubbi/Proffy.git>

# Access the project folder from a terminal
$ cd Proffy

# Go to the server folder
$ cd server

# Install dependencies
$ yarn

# Run API on dev mode
$ yarn start

# The server will start at port:3333 - access <http://localhost:3333>


#### Start web app ####

# Access the project folder from a terminal
$ cd Proffy

# Go to the web folder
$ cd web

# Install dependencies
$ yarn

# run web ap on dev mode
$ yarn start

# The web app will start at port:3000 - access <http://localhost:3000>


#### Start mobile app ####

# Access the project folder from a terminal
$ cd Proffy

# Go to the mobile app folder
$ cd mobile

# Install dependencies
$ yarn

# run mobile app on real device(you'll need to have an Expo client app installed in your device - <https://expo.io/tools#client>)
$ yarn start

# Your browser will open with an available QR code.
# Scan the QrCode and the Expo client app will open with your project running

# run mobile app on iOS emulator(you'll need to be on a MacOS)
$ yarn start ios

# run mobile app on Android emulator
$ yarn start android

# The mobile app will start in an emulator

🛠 Technologies

• Node.js
• React
• React Native
• TypeScript
• SQlite
• Knex.js
• Axios
• Expo
• VS Code

✍️ Author

---

_{Thales Sarubbi}

Made with 💙 by Thales Sarubbi 🗣 Let's talk!