https://github.com/blockcoders/nestjs-api-boilerplate

A boilerplate for building production-ready RESTful APIs using NestJS
https://github.com/blockcoders/nestjs-api-boilerplate

boilerplate express fastify github-actions nest nestjs nestjs-backend nestjs-boilerplate nodejs pnpm rest-api starter typescript workflow

Last synced: 8 days ago
JSON representation

A boilerplate for building production-ready RESTful APIs using NestJS

• Host: GitHub
• URL: https://github.com/blockcoders/nestjs-api-boilerplate
• Owner: blockcoders
• Created: 2021-11-05T20:55:22.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-05T20:09:46.000Z (over 2 years ago)
• Last Synced: 2024-04-14T10:32:58.877Z (7 months ago)
• Topics: boilerplate, express, fastify, github-actions, nest, nestjs, nestjs-backend, nestjs-boilerplate, nodejs, pnpm, rest-api, starter, typescript, workflow
• Language: TypeScript
• Homepage:
• Size: 352 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NestJS Api Boilerplate

REST API NestJS Quick Start

## Environment setup

 - Install [Node.js](https://nodejs.org/)

   - Recommended method is by using [NVM](https://github.com/creationix/nvm)

   - Recommended Node.js version is v16.13

 - Install [Docker](https://docs.docker.com/get-docker/)

## Get Started

Install all the dependencies:

```

pnpm i --frozen-lockfile

```

Copy the `.env.sample` file to `.env`

```

cp .env.sample .env

```

In the project directory, you can run:

### `pnpm start:dev`

Runs the NodeJs services in the development mode.\

Open [localhost:8080/api/v1/ping](http://localhost:8080/api/v1/ping) to view it in the browser or Postman.

The service will reload if you make edits.

## Test

### `pnpm test`

Running the unit tests.

### `pnpm test:cov`

Running the test coverage.