Skip to content

imvasen/nest-boilerplate

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

This template intends to provide you with a Nest framework starter repository that complies with The Twelve Factor App guidelines.

It provides the following features:

  • Config service - Set to fail if required variables are not found.
  • Auth module with JWT strategy, login & sign up.
  • DB config (PostgreSQL or CockroachDB).
  • Basic GH Workflow.

Installation

$ pnpm install

Running the app

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

When the app starts, it looks for the configuration in environment variables. If such variables are not set, it fails on start. These variables can be also set with a .env file.

The required variables can be found (or modified) at this file. Or use .env.sample as a reference.

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.

About

A boilerplate for your NestJS projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published