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

Description

Nest framework TypeScript custom starter boilerplate repository.

Changes

• Fastify instead of Express
• @nestjs/config Module initialized
• nestjs-prisma Module initialized
• class-validator, class-transformer and ValidationPipe configured
• BiomeJS configured with @nedcloarbr/biome-config instead of ESLint and Prettier
• @nestjs/swagger Configured
• @nestjs/terminus Health checks for api and prisma
• Vitest with Vitest UI and coverage-v8 instead of Jest
• nestjs-otel/Open Temeletry Pre-configured
• Docker compose file

Installation

# install packages
$ yarn install

# initialize prisma client and sync with database
$ yarn prisma migrate dev

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:coverage

Using Docker

# Start container
$ docker compose up -d

# View logs
$ docker compose logs -f

Viewing Metrics

• Swagger: http://localhost:9000/docs
• Grafana: http://localhost:3000

Warning

PORTS THAT CANNOT BE USED IN THIS PROJECT

Metrics API(src/lib/metrics.ts)
8081 -> OtelSDK

Metrics otel-collector(docker-compose.metrics.yml)
1888 -> pprof extension
8888 -> Prometheus metrics exposed by the collector
8889 -> Prometheus exporter metrics
13133 -> health_check extension
4317 -> OTLP gRPC receiver
4318 -> OTLP HTTP receiver
55679 -> zpages extension

Metrics tempo(docker-compose.metrics.yml)
14268 -> jaeger ingest
3200 -> tempo
4317 -> otlp grpc
4318 -> otlp http
9411 -> zipkin

Metrics loki(docker-compose.metrics.yml)
3100 -> loki

Metrics prometheus(docker-compose.metrics.yml)
9090 -> prometheus

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
  • NestJS Kamil Myśliwiec
  • Boilerplate NedcloarBR
• Website
  • NestJS https://nestjs.com
  • Boilerplate NedcloarBR
• Twitter
  • NestJS @nestframework
  • Boilerplate @BrNedcloar

License

Nest is MIT licensed.