Proffy - Get in touch with any teacher and learn what you want.

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

📚 About the project

This project was developed on the Next Level Week #02 event by Rocketseat 🚀 💜

This application is designed to connect teachers and students. For teachers, it is possible to define the start and end time of classes, the hourly price and describe themselves. Studens can get in touch and choose favorites teachers.

🚀 Technologies

Technologies that I used to develop this application

• Node.js
• ReactJS
• React Native
• TypeScript
• Expo
• Express
• TypeORM
• JWT-token
• PostgreSQL
• React Router DOM
• React Navigation
• Husky
• Commitlint
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn
• Expo
• One instance of PostgreSQL

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/EliasGcf/proffy.git && cd proffy

Install dependencies

$ yarn

Follow the steps below

Backend

# Create the instance of postgreSQL using docker
docker run --name proffy-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=proffy -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Use the script to run the migrations
$ yarn server typeorm:migration:run

# To finish, run the api service
$ yarn server dev:server

# Well done, project is started!

Web

Obs.: Before to continue, be sure to have the API running

# Be sure the file 'packages/web/src/services/api.ts'
# have the IP to your API

# Start the client
$ yarn web start

Mobile

Obs.: Before to continue, be sure to have the API running

# Be sure the file 'packages/mobile/src/services/api.ts'
# have the IP to your API

# Start the expo service and scan the QR code with Expo Client
$ yarn mobile start

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork EliasGcf/proffy

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd proffy

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Elias Gabriel 👋  See my linkedin