/Proffy-API

API to the Proffy App.

Primary LanguageTypeScript

Proffy
Made by Rocketseat Ministered by Diego Fernandes NLW 2
WebProffy Proffy Mobile

Made with 💜

📚 About the project

Proffy is an application made for the purpose of easily connecting students and teachers. Through this application, students can find teachers and get in touch with them. For proffys, they can gather students and schedule classes.

📌 Technologies

⚙ Status codes

Status Description
200 OK
400 BAD REQUEST
401 UNAUTHORIZED
404 NOT FOUND
500 INTERNAL SERVER ERROR

🚀 Running

  • Clone this repository: $ git clone https://github.com/raphaacosta/Proffy-API.git.
  • To install all dependencies, run: $ yarn install or $ npm install
  • Initiate the database run: $ yarn knex:migrate
  • Now, run: $ yarn dev or $ npm dev to developer version.
  • You can use Insomnia or Postman to test.

👍 Contribute

  • Fork this repository.
  • Create a branch with your resource: git checkout -b my-feature.
  • Submit changes: git commit -m "feat: My new feature".
  • Push your branch: git push origin my-feature.