README.md

Nestjs Prisma Template

This is an opinionated template for Nestjs prisma restful projects.

Features

• Platform: Express

• Database:

  • ORM: Prisma
  • Redis: Redis

• Cache Manager: cache-manager

• Logger: Pino

  • nestjs-pino
  • rotating-file-stream
  • pino-pretty in development
  • pino-loki

• health

• Authentication: Passport

  • JWT: passport-jwt
  • Google: passport-google-oauth20

• Swagger: @nestjs/swagger

• Tracing: nestjs-otel

  • grafana
  • loki
  • prometheus
  • promtail
  • tempo
  • alertmanager

• k8s

Guide

Development

Init environment variables:

cp .env.example .env

Install dependencies:

pnpm install

Generate Prisma client:

pnpm run prisma:migrate

Migrate database:

pnpm run prisma:migrate:dev

Run the app:

pnpm run start:dev

Deployment with docker

Docker:

docker-compose build

start docker-compose

docker-compose up -d

In Node.js Environment:

pnpm install
pnpm run build
pnpm run start:prod

Migrate database

Development:

pnpm run prisma:migrate:dev

Production:

pnpm run prisma:migrate:deploy

Overview

swagger

opentelemetry

prometheus

alerting

k8s

ingress

Acknowledgements

• nestjs-prisma
• nestjs-otel
• nestjs-otel-prom-grafana-tempo