Skip to content

higormelo-dev/gympoint_api

Repository files navigation


Gympoint

GymPoint API

An API for gym manager.

PRs Welcome License MIT


Features

A Node.js API built with Express and all the latest tools and best practices in development!

  • Express — A web framework for Node
  • 💾 Sequelize — SQL dialect ORM for Node.js (Use it PostgreSQL or MySQL)
  • 🍂 MongoDB — document-based database
  • 🔑 Redis — key-value data model
  • ⌨️ Yup - Object schema validation
  • 🔺 Sentry - cross-platform application monitoring
  • 📧 Nodemailer - Send e-mails with Node.JS
  • 💖 Lint — ESlint/Prettier/Editor Config
  • Sucrase
  • Nodemon

Dependencies

Prerequisites

In the next few weeks, I plan to include Docker directly in the repository with docker-compose, until there this step is required.

To run this server you will need three containers running on your machine.

Remember: If you restart your machine, you will need to start again the server with docker start <container_id>.

Getting started

Consider checking out the FrontEnd repository!

  1. Clone this repo using https://github.com/higormeloap89/gympoint_api.git
  2. Move to the appropriate directory: cd gympoint_api.
  3. Run yarn to install dependencies.
  4. Add all the values for the environment variables.
  5. Run yarn start and yarn queue to run the servers at http://localhost:3333.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published