csdev19 / nest-boilerplate

🔥 Nest boilerplate to create projects as fast as possible 🔥

Nest Boilerplate

🔥 Nest boilerplate to create projects as fast as possible 🔥

Features

• Nestjs performance Fastify
• Swagger
• Typeorm
• Docker compose
• Eslint
• Prettier
• Docker
• Jest

Code standards

• The modules are plural (module-name.module.ts)
• The controllers are plural and his path too (controller-name.controller.ts)
• The services are plural (service-name.service.ts)
• The entities are singular (entity-name.entity.ts)

Actual Folder structure

├── dist/
├── docker-compose.yml
├── Dockerfile
├── nest-cli.json
├── package.json
├── package-lock.json
├── README.md
├── src/
│   ├── app.module.ts
│   ├── main.ts
│   └── modules/
│       ├── <module-name>/
│       │   ├── <module-name>.module.ts
│       │   ├── dtos/
│       │   ├── entities/
│       │   ├── services/
│       │   └── interfaces/
│       ├── authentication/
│       │   ├── authentication.controller.ts
│       │   ├── authentication.module.ts
│       │   ├── constants/
│       │   ├── decorators/
│       │   ├── dtos/
│       │   ├── encrypt/
│       │   ├── guards/
│       │   ├── services/
│       │   └── strategies/
│       └── note
│           ├── dtos/
│           ├── interfaces/
│           ├── note.controller.ts
│           ├── note.entity.ts
│           ├── note.module.ts
│           └── note.service.ts
├── test/
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── tsconfig.build.json
└── tsconfig.json

Module structure

├── <module-name>/
│   ├── <module-name>.module.ts
│   ├── dtos/
│   ├── entities/
│   ├── services/
│   └── interfaces/

Contributors

• Author - Cristian Sotomayor @csdev

Extra

If youy want to use snake-case go to this package

Docker

There is a docker-compose.yml file for starting Docker.

docker-compose up

After running the sample, you can stop the Docker container with

docker-compose down

docker-compose up -d postgres
docker-compose ps
docker-compose down

docker investigation

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

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm 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

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.