/nestjs-starter

Project template for Nest.js

Primary LanguageTypeScriptMIT LicenseMIT

nestjs-starter

Project template for Nest framework.

Feature

  • Using Airbnb JavaScript Style Guide.
  • Normalize project folders.
  • Integrated with GraphQL.
  • Integrated with Database(eg: mysql).
  • Integrated with Swagger.
  • Jwt auth token.
  • Redis cache.
  • Integrated with health check using terminus.

Installation

$ yarn install

Environment

You should install mysql firstly, or you can use mysql docker image instead, docker-compose.yml had predefined the mysql environment, you can start it by docker-compose up;

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

License

MIT licensed.