ennioma / nestjs-starter

Minimal NestJS boilerplate

nestjs-starter

Minimal NestJS boilerplate

Getting started

Setup

git clone https://github.com/zsevic/nestjs-starter
cd nestjs-starter
cp .env.sample .env # change values after copying
npm i
npm run start:dev

Build

npm run build
npm start

Docker compose

cp .env.sample .env
docker-compose up --build -V --remove-orphans # for development environment
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up --build -V
docker-compose down

Linting

npm run lint
npm run lint:fix

Testing

npm test
npm run test:e2e

Migrations

npm run migration:generate database/migrations/<MIGRATION_NAME>
npm run migrate
npm run migrate:down

Seeders

npm run seed:generate database/seeders/<SEEDER_NAME>
npm run seed
npm run seed:down

API documentation

API documentation is generated using @nestjs/swagger module at /api-docs endpoint

Technologies used

• Node.js, TypeScript, NestJS, TypeORM