README.md

NestJS Boilerplate

NestJS + Fastify + Prisma + PostgreSQL + Swagger REST API boilerplate.

Table of Contents

• Requirements
• Installation
• Running Docker
• Seeding the Database
• Running the app
• Testing
• Future Improvements

Requirements

1. Docker Desktop (or similar) with support for docker-compose
2. NodeJS v20

Commands

Install Dependencies

$ npm install

Running Docker

# docker full solution -> will install the app dependencies and run it in watch mode
$ docker compose up -d

# database only
$ docker compose up -d postgres

Seeding the Database

$ npx prisma db seed

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Running the tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Future Improvements

1. Improve API configurtion and security

   • Take leverage of the framework's builtin modules

   • Add Helmet security headers

   • Add Cross-site request forgery security

   • Add Rate Limiting

   • Add Cache

   • Add Configuration

   • Add Healthchecks (replace current hard-coded implementation)

   • Add Documentation for devs

   • Implement HTTPS

   • Implement Authentication and Authorization with Auth Guards. Move them to an Auth module

   • Implement better Exception Filters

2. Database

   • Manage dotenv files per environment
   • Improve security of the database