Backend Guide

Backend Guide

How to run, configure, and operate the NestJS template with Docker Compose or a native setup.

Pages

Installation and Configuration

Docker Compose, environment variables, connection pools, Kafka KRaft, Graylog, MailHog, and native Ubuntu setup.

Users module

Administrative CRUD over REST and GraphQL, Role enum, and persistence rules.

Email module

SMTP/Mailer, Auth confirmation and reset flows, and authenticated POST /email/send.

WhatsApp module

Evolution API, phone number sent as-is, and authenticated POST /whatsapp/send.

WebSocket

Socket.IO gateway, type-based message handlers, and how to create a feature module.

Useful shortcuts

  • /swagger — Swagger
  • /health — Health (includes Postgres/Mongo pool metadata)
  • / — This documentation
  • /api/v1 — REST API base path
  • /users — Users module documentation
  • /email — Email module documentation
  • /whatsapp — WhatsApp module documentation
  • /websocket — WebSocket documentation
  • /mailhog/ — MailHog (test emails)