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

Description

Nest framework TypeScript starter repository.

Configurações e Qualidade de Código

Este projeto já vem configurado com as principais ferramentas para garantir qualidade, padronização e segurança no desenvolvimento:

• ESLint: Linting de código para manter o padrão e evitar erros comuns.
• Prettier: Formatação automática do código.
• Husky: Hooks de Git para automatizar checagens antes de commits e push.
• lint-staged: Garante que apenas arquivos alterados sejam verificados e formatados antes do commit.
• Commitlint: Padroniza as mensagens de commit.
• Cobertura mínima de testes: O projeto exige pelo menos 80% de cobertura global de testes (statements, branches, functions e lines).
• Pre-push: Antes de enviar código para o repositório remoto, são executados automaticamente os comandos de lint, build e testes com cobertura. O push é bloqueado caso a cobertura mínima não seja atingida.

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage (mínimo exigido: 80%)
$ npm run test:cov

Se a cobertura global de testes estiver abaixo de 80%, o push será bloqueado automaticamente pelo hook de pre-push.

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

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

License

Nest is MIT licensed.

Variáveis de Ambiente

Crie um arquivo .env na raiz do projeto com base no .env.example:

DB_USER=postgres
DB_PASS=postgres
DB_HOST=db
DB_PORT=5432
DB_NAME=protect_sys_erp
DB_SCHEMA=public
REDIS_HOST=redis
CONTAINER_NAME=nestjs-boilerplate
APP_PORT=3000

Essas variáveis são usadas para montar a DATABASE_URL dinamicamente no docker-compose.yml:

environment:
  - DATABASE_URL=postgresql://${DB_USER}:${DB_PASS}@${DB_HOST}:${DB_PORT}/${DB_NAME}?schema=${DB_SCHEMA}
  - REDIS_HOST=${REDIS_HOST}

---

LocalStack e Scripts de Inicialização

O projeto utiliza o LocalStack para simular serviços AWS localmente. Os scripts de setup em scripts/localstack/ são executados automaticamente toda vez que o container LocalStack sobe, criando buckets S3, tópicos SNS, secrets, etc.

Como funciona:

• Todos os scripts em scripts/localstack/ são mapeados para /docker-entrypoint-initaws.d no container LocalStack.
• O LocalStack executa esses scripts automaticamente na inicialização.
• Os scripts são idempotentes: se o recurso já existe, apenas ignoram ou avisam.

Scripts auxiliares

• scripts/setup-aws-cli.sh: Instala/configura a AWS CLI no seu ambiente local. Execute apenas uma vez por máquina.
• scripts/setup-localstack.sh: Facilita o setup local, parando/subindo containers e executando os scripts de setup manualmente. Use quando quiser garantir que o ambiente está limpo e todos os recursos foram criados do zero.

---

Fluxo de Setup Local

1. Copie .env.example para .env e ajuste as variáveis conforme necessário.
2. Instale as dependências:

   npm install

3. (Opcional) Instale a AWS CLI localmente:

   ./scripts/setup-aws-cli.sh

4. Suba os containers:

   docker-compose up

   Os scripts de setup do LocalStack serão executados automaticamente.
5. Rode as migrações do Prisma:

   npx prisma migrate dev

6. Execute os testes:

   npm run test
   npm run test:cov

---

Observações

• O arquivo .env não deve ser versionado (já está no .gitignore).
• Sempre mantenha o .env.example atualizado para facilitar o onboarding de novos desenvolvedores.
• Os scripts de setup do LocalStack podem ser ajustados conforme a necessidade de novos recursos AWS simulados.