Giter Club home page Giter Club logo

gympoint-api's Introduction

Gympoint

Gym Management App made with Express

GitHub language count Made by Laura Beatris License Stargazers

About the projectย ย ย |ย ย ย  Goalsย ย ย |ย ย ย  Installationย ย ย |ย ย ย  Licence

๐Ÿš€ About the project

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

โ˜‘๏ธ Goals

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.

๐Ÿƒ Installation

  // 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

๐Ÿ“จ Routes

Soon.

Status Codes

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

๐Ÿ“ Licence

MIT Licence. See the file LICENSE for more details.


Made with โ™ฅ by Laura ๐Ÿ‘‹ See my linkedin!

gympoint-api's People

Contributors

laurabeatris avatar raphaeloliveiramoura avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.