Pro Plan Documentation
Learn what the starter kit provides, how its modules fit together, and where to begin.
NestJS Modular Monolith Starter Kit
This starter kit is a single deployable NestJS application organized around explicit business-module boundaries. It provides a working foundation for products that need authentication, user administration, role-based authorization, PostgreSQL persistence, and production-oriented HTTP behavior.
What is included
- JWT access authentication and rotating refresh-token sessions.
- HTTP-only refresh cookies and double-submit CSRF protection.
- Registration, email verification, password changes, and session management.
- Self-service and administrative user lifecycle operations.
- Roles, permissions, per-user overrides, super-administrator safeguards, and RBAC audit records.
- PostgreSQL persistence with TypeORM and explicit migrations.
- OpenAPI generation and a Scalar API reference.
- Global validation, Problem Details errors, rate limiting, CORS, and Helmet.
- Structured logs, request IDs, liveness, and readiness checks.
- SMTP email delivery, Handlebars templates, and Mailpit for development.
- Unit, end-to-end, and CI workflows.
Requirements
| Tool | Supported version |
|---|---|
| Node.js | >=24 <25 |
| pnpm | 10.34.5 |
| PostgreSQL | 17 or a compatible release |
| Docker | Optional; used by the included local-service workflow |
Documentation map
| Goal | Read |
|---|---|
| Run the API locally | Getting Started |
| Understand module boundaries | Architecture |
| Configure an environment | Configuration |
| Integrate login and sessions | Authentication |
| Manage accounts | User Management |
| Configure authorization | Role-Based Access Control |
| Understand HTTP contracts | API Overview |
| Change the schema safely | Database and Migrations |
| Build a production image | Deployment |
| Operate the service | Operations |
| Verify a change | Testing |
| Resolve a common failure | Troubleshooting |
API discovery
When OPENAPI_ENABLED=true, the running application exposes:
- Scalar API reference:
http://localhost:3000/docs - OpenAPI JSON:
http://localhost:3000/openapi.json
The generated OpenAPI document is the authoritative endpoint catalog. These guides focus on workflows, contracts, and operational behavior so endpoint details do not drift away from the code.
Recommended path
- Complete Getting Started.
- Read Architecture before adding a module.
- Review Authentication and API Overview before building a client.
- Use the local Scalar reference to inspect exact request and response schemas.
- Read Deployment before creating a production environment.