A Rest API that helps you to manage students, enrollments, plans of a gym 🚀
- Features
- Installation
- Getting Started
- FAQ
- Found a bug? Missing a specific feature?
- Contributing
- License
- Students CRUD
- Plans CRUD
- Enrollments CRUD
- Students are able to create questions related to their doubts that will be sent to instructors.
It's important to mention that this is one of the applications from the Gympoint System
In order to explore the others, feel free to click in the links above:
You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:
git clone https://github.com/LauraBeatris/gympoiny-api.git
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
git clone git@github.com:LauraBeatris/gympoint-api.git
Run the transactions in order to configure the database schema
npx sequelize-cli db:migrate
Run the following command in order to start the application in a development environment:
// Start the server
yarn dev
// Run the queue responsable for the mail job
yarn queue-dev
Gympoint returns the following status codes in its API:
| Status Code | Description |
|---|---|
| 200 | OK |
| 422 | UNPROCESSABLE ENTITY |
| 400 | BAD REQUEST |
| 404 | NOT FOUND |
| 500 | INTERNAL SERVER ERROR |
Question: What are the tecnologies used in this project?
Answer: The tecnologies used in this project are NodeJS + Express Framework to handle the server and Sequelize
Feel free to file a new issue with a respective title and description on the the Gympoint API repository. If you already found a solution to your problem, I would love to review your pull request! Have a look at our contribution guidelines to find out about the coding standards.
Check out the contributing page to see the best places to file issues, start discussions and begin contributing.
Released in 2019. This project is under the MIT license.
Made with love by Laura Beatris 💜🚀