Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.51 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.51 KB

Gympass-like API Solid - NodeJS + Prisma

English Português

Description

This project consists of a REST API for a Gympass-like app, applying SOLID principles with TypeScript + Prisma ORM.

Requirements

Before you begin, ensure you have met the following requirements:

  • Node.js (v20.x).
  • Npm (v8.x)
  • Docker (v27.x)
  • Docker Compose (v2.x)

Installation & Setup

Instructions on how to install and set up the project for development.

  1. First, let's install the project dependencies with npm:
# Install dependencies
npm install
  1. Set your environment variables correctly in the .env file (refer to .env.example for guidance):

  2. Now, make sure to run the docker containers using docker compose:

docker compose up -d
  1. Next, we need to run prisma migrations in order to create tables and populate the database:
npx prisma run dev
  1. Finally, run the project in development mode with:
npm run "start:dev"

License

This project is intended for learning purposes only and is not licensed for commercial use.

Contributors

Photo of Roger Bambinetti
Roger Bambinetti