Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 1.39 KB

README.md

File metadata and controls

85 lines (64 loc) · 1.39 KB
Raw

Nest Logo

NestJS Boilerplate

Description

NestJS Boilerplate app with Node 18+, docker-compose, Postgres, TypeORM, Joi and GitHub Actions

Endpoints:

GET - get all todos

localhost:3000/tasks

POST - create new todo

localhost:3000/tasks

BODY json payload example:
{
    "content": "some todo"
}

PATCH - set the existing "todo" as done

localhost:3000/tasks/:id

BODY json payload example:
{
    "done": true
}

DELETE - remove todo

localhost:3000/tasks/:id

Installation

$ cp .env.dist .env
$ cp docker-compose.override.yml.dist docker-compose.override.yml
$ npm install

Used Nodejs v20.9.0

Running the back-end

# start db
$ docker compose up -d postgres

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# create a docker backend-service image and run the app
$ docker compose up

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

MIT licensed.