Project   |    Techs   |    Installation   |    Start   |    Contributing   |    License

Project 🌟

Proffy is a simple project made to connect teachers to students, the users can register their information and available hours/price if they want to teach or search available classes from other teachers, based on knowledge field.

It was idealized by Rocketseat's Next Level Week #2.

Deployed here.

Techs 🚀

• ReactJS;
• React Native;
• Node.js;
• TypeScript;
• Styled Components.

Installation 🔧

First, clone the repository using:

# Clone Repository
$ git clone https://github.com/leoronne/proffy.git

Then you can install the application using npm install or yarn install on the client, server and mobile dir.

Start 🔛

To start the application interface just run npm start or yarn start on the client dir or npm run startclient / yarn startclient on the root dir.

To start the application mobile bundle just run npm start or yarn start on the mobile dir or npm run startmobile / yarn startmobile on the root dir.

To start the application server just run npm run dev or yarn dev on the server dir or npm run startserver / yarn startserver on the root dir.

Remember to run the migrations on the server dir using npm run knex:migrate or yarn knex:migrate (the DB used on this project is based on PostgreSQL).

Note: you need to create a .env file on the directories based on the example file in each dir.

Contributing 🤔

Please read CONTRIBUTING for details on code of conduct, and the process for submitting pull requests to the project.

License 📝

• MIT license
• Copyright 2020 © Leonardo Ronne.