A simple way to connect students and teachers!

About |  How to use |  Technologies |  How to contribute |  License

📗 About

Proffy is an online study platform that aims to connect students with teachers

🚀 Technologies

The project was developed using the following technologies

API

• Node.JS
• TypeScript
• Express
• ts-node-dev
• SQLite3
• KnexJS

WEB

• ReactJS
• Typescript
• React Router

📝 How to use

To clone and run this application, you will need Git, Node.js v10.16 or higher + Yarn v1.13 or higher installed on your computer. On your command line:

# Clone this repository
$ git clone https://github.com/sidneymiranda/project-proffy

# Enter the directory
$ cd proffy

# Run the command below
$ yarn install

#  Run the command below
$ yarn start

🔗 How to contribute

• Fork the repository
• Clone your repository
• Create a branch with your feature
• Commit your changes
• 'Push' your branch
• Go to Pull Requests of the original project and create a pull request with your commit

✔️ License

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

---

Made with ❤️ by Sidney Miranda