CInCoders NestJS StarterKit
Documentação técnica e arquitetural do boilerplate NestJS 11 com Prisma, Keycloak e Zod.
CInCoders NestJS StarterKit
Bem-vindo à documentação oficial do CInCoders NestJS StarterKit mantido pelo CInCoders.
Este projeto fornece uma base estruturada, robusta e modular para a criação de microsserviços e APIs REST em Node.js com TypeScript, seguindo as melhores práticas de engenharia de software da comunidade.
⚡ Stack Tecnológica
| Componente | Ferramenta / Versão | Finalidade |
|---|---|---|
| Runtime | Node.js 24 LTS | Ambiente de execução JavaScript/TypeScript |
| Framework | NestJS 11 | Arquitetura modular com Injeção de Dependências (DI) |
| ORM | Prisma 5 | Client type-safe, schema declarativo e Migrations |
| Banco de Dados | PostgreSQL 14+ | Banco de dados relacional primário |
| Autenticação | Keycloak + jose 6 | Validação JWT stateless via JWKS com política fail-closed |
| Validação | Zod 3 + nestjs-zod | Schemas únicos para validação, tipagem e OpenAPI |
| Documentação | Swagger / OpenAPI | Documentação interativa servida em /api/docs |
| Testes | Vitest 4 | Runner ultrarrápido de testes unitários e de integração |
| Qualidade & Lint | Biome 2 | Linter e formatador de código de alto desempenho |
| Git Hooks | Husky 9 + commitlint | Validação de Conventional Commits pré-commit |
📖 Nunca trabalhou com backend web? Comece aqui
Se você ainda não tem experiência com APIs, ORMs ou frameworks web, não pule direto para o setup. Leia primeiro a Leitura Obrigatória — ela reúne os conceitos essenciais e a documentação oficial de cada tecnologia usada no projeto, na ordem certa para aprender.
🧭 Tópicos Principais
- Leitura Obrigatória: Conceitos e documentações essenciais antes de começar
- Setup & Inicialização: Como gerar um novo projeto
- Keycloak Local: Estrutura do realm pré-configurado
- Visão Geral da Arquitetura: Princípios arquiteturais
- Autenticação & Autorização: Estratégia de segurança
- Persistência & Migrations: Estrutura de dados
- Criação de Módulos: Guia passo a passo
- Guia de Testes: Testes unitários e integração