Blockchain labs Nest.js framework Boilerplate

• updated at 24.08.26
• updated by evan

Command(default npm)

# Installation
$ npm install

# development running
$ npm run start
# watch mode running
$ npm run start:dev
# production mode running
$ npm run start:prod

# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov

Project Structure Example(src/ folder)

├── app.controller.spec.ts
├── app.controller.ts
├── app.module.ts
├── app.service.ts
├── main.ts
├── common
│   ├── # Project Self Common Module
│   └── config, constant, decorator, entity...
├── domain
│   ├── # The actual business logic and the module folder including controllers.
│   └── user
│       ├── dto
│       ├── entity
│       ├── interface
│       ├── user.controller.ts
│       ├── user.module.ts
│       ├── user.repository.ts
│       ├── # unit test file
│       ├── user.service.spec.ts
│       ├── user.service.ts
│       └── ...
├── shared
│   ├── # Custom, open-source common modules
│   ├── database
│   │   ├── database.module.ts
│   │   └── database.service.ts
│   └── ...
└──

Conventions

Nest.js Conventions

Typescript Conventions