galax-api

This project focus on an API with Nestjs

Attention: this Readme file is under construction

CI/CD Step

[x] Create a simple CI/CD file to check if the project have conflicts on branch

First Step

[x] Make a json file to compose our database design schema interfaces and entities [] Make migrations and seeds [x] Make Nestjs base environment [x] Make by cli structure SOLID

Documentation Step

[x] Document the API (SWAGGER)

Nest framework TypeScript starter repository.

Installation

$ npm install

Docker Use

Docker Build

$ docker-compose up --build

Docker Run

$ docker-compose up

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.