About the project | Goals | Installation | Licence
Rest API of the Gympoint System. As a admin, you're able to see the list of students, registrations and plans, as well edting/creating new ones. Also, answer and see the help orders that're pending.
As a student, you're able to do checkins, help orders and also get to know what the intructors answered. Students're allowed to do only 5 checkins per week.
Future features:
- Trainings made by the Personal Trainer
- Students can access some datas that show how they've been improving in their trainings
To see the student interface, click here to take a look in the mobile aplicattion: Gympoint Mobile
To see the admin interface, click here to take a look in the web aplicattion: Gympoint Web
Apply all the important concepts of a Rest API with Express and Sequelize ORM, using a services like PostgreSQL, MongoDB, Redis with BeeQueue and Nodemailer with Mailgun.
// 1 - Git Clone
// 2 - Copy the .env.example and set the environment variables
cp .env.example .env
// 3 - Run the services (Be sure to have docker and docker-compose installed)
docker-compose up -d
// 4 - Once the services are running, its time to install the dependencies
yarn install
// 5 - Run the application
yarn dev
// 6 - Run the application queue for the mail job
yarn queue-dev
Soon.
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 |
MIT Licence. See the file LICENSE for more details.
Made with ♥ by Laura 👋 See my linkedin!