NestJS Api Boilerplate

REST API NestJS Quick Start

Environment setup

• Install Node.js
  • Recommended method is by using NVM
  • Recommended Node.js version is v20.x
• Install Docker

Get Started

Install all the dependencies:

npm ci

Copy the .env.sample file to .env

cp .env.sample .env

In the project directory, you can run:

npm start:dev

Runs the NodeJs services in the development mode.
Open localhost:8080/api/v1/ping to view it in the browser or Postman.

The service will reload if you make edits.

Test

npm test

Running the unit tests.

npm test:cov

Running the test coverage.