Skip to content

Latest commit

 

History

History
119 lines (89 loc) · 3.83 KB

README.md

File metadata and controls

119 lines (89 loc) · 3.83 KB
Raw

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

A Nest and TS production-grade template for enterprise - batteries included w/ Prisma, Compodoc, Swagger, Jest and more..

Features

  • NestJS
  • Typescript
  • Linting w/ eslint and prettier
  • Unit Testing w/ jest
  • Integration and E2E Testing w/ cypress
  • Logging w/ pino and pino-http
  • Documentation w/ compodoc
  • OpenAPI w/ swagger
  • ORM w/ prisma and postgreSQL
  • Release management w/ standard-version
  • Commitlint
  • Commitizen
  • Husky
  • Docker and Docker-compose

Installation

# Install packages
$ yarn

# Copy .env.example to .env
$ cp .env.example .env

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

Commit and Versioning

# Commit
$ yarn commit

# Release
$ yarn release

Compodoc

# Init compodoc documentation
$ yarn documentation:serve

Cypress

# Init cypress UI
$ yarn cypress:open

Git

# Cleanup local git branches
$ yarn git:cleanup

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.

License

Nest is MIT licensed.