NestJS Framework Boilerplate (PostgreSQL)

A local development setup or boilerplate for Nest.js framework with PostgreSQL and pgAdmin4 using Docker Compose.

Quick Start

1. Install Node.js - for IDE type checking.
2. Install Yarn - for IDE type checking.
3. Install Docker Compose and make sure it is running in the system background.
4. Clone the app:

git clone git@github.com:dominicarrojado/nestjs-postgres-boilerplate.git

5. Install npm packages - for IDE type checking.

cd nestjs-postgres-boilerplate
yarn install --frozen-lockfile

6. Build and run the Docker image.

yarn docker-compose:dev

7. Access the app at http://localhost:3000.
8. Make file changes and it will automatically rebuild the app.

Running All Tests

yarn docker-compose:test

Running All Tests (with coverage)

yarn docker-compose:test:cov

Running Tests (Watch)

1. Build and run the Docker image.

yarn docker-compose:test:watch

2. Make file changes and it will automatically rerun tests related to changed files.

Build For Production

yarn docker-compose:prod

VSCode Extensions

• Prettier
• ESLint

Learn

Learn how to build this setup or boilerplate here.