Gympoint API

A Rest API that helps you to manage students, enrollments, plans of a gym :rocket:

:pushpin: Table of Contents

• Features
• Installation
• Getting Started
• FAQ
• Found a bug? Missing a specific feature?
• Contributing
• License

:rocket: Features

• 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:

• Gympoint Mobile
• Gympoint Web

:construction_worker: Installation

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 [email protected]:LauraBeatris/gympoint-api.git

:runner: Getting Started

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

Status Codes

Gympoint returns the following status codes in its API:

:postbox: Faq

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

:bug: Issues

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.

:tada: Contributing

Check out the contributing page to see the best places to file issues, start discussions and begin contributing.

:closed_book: License

Released in 2019. This project is under the MIT license.

Made with love by Laura Beatris 💜🚀