Setup Rápido

O boilerplate foi desenvolvido para permitir a instanciação ágil de novos microsserviços sem alterar o repositório original.

✅ Requisitos

Antes de rodar o gerador, tenha instalado:

• Node.js 24 LTS — mesma versão usada pelo boilerplate (.nvmrc/.node-version). Use nvm install 24 && nvm use 24 se tiver o nvm.
• Docker + Docker Compose — para subir PostgreSQL e Keycloak no ambiente de desenvolvimento do projeto gerado.
• bash, git, curl, perl, tar e coreutils (sed, awk, find) no PATH — já presentes em qualquer Linux/macOS.

🪟 Windows

O setup.sh depende de utilitários POSIX e não roda no CMD ou PowerShell nativos. Instale o Git Bash e rode todos os comandos desta página a partir dele (o Git for Windows já traz bash, curl, perl, tar e os coreutils necessários).

🧩 Gerando Frontend + Backend de Uma Vez

Se o objetivo é começar um projeto CIn novo do zero, com frontend e backend juntos, use o repositório platform/boilerplate em vez de gerar cada um separadamente.

Ele clona o cincoders-nestjs-boilerplate e o cincoders-reactjs-boilerplate numa única execução, pergunta os dados compartilhados (nome, descrição, remote) uma única vez e cria <nome>-back e <nome>-front lado a lado, já com nome técnico e URLs alinhados entre os dois projetos. O realm do Keycloak (Local) já é o mesmo nos dois, independente do nome técnico.

Numa pasta vazia (ou onde quiser as duas pastas do projeto):

curl -fsSL https://gitlab.cin.ufpe.br/cincoders/platform/boilerplate/-/raw/main/setup.sh | bash

Use essa opção quando precisar do par frontend + backend. Para gerar apenas o backend (por exemplo, para adicionar a um frontend já existente), siga a seção abaixo.

🚀 Gerando um Novo Projeto (Somente Backend)

Rode a partir da pasta onde quer criar o projeto:

curl -fsSL https://gitlab.cin.ufpe.br/cincoders/platform/cincoders-nestjs-boilerplate/-/raw/main/setup.sh | bash

O gerador detecta que não há repositório no diretório atual, clona o boilerplate num diretório temporário, executa a instanciação de lá e apaga o clone ao terminar. O projeto é criado no diretório de onde você chamou o comando.

Perguntas do Assistente Interativo

Durante a execução, as seguintes configurações serão solicitadas:

🛠️ Executando o Projeto

Após o setup, acesse o diretório criado e inicialize os serviços de infraestrutura com Docker Compose:

# 1. Navegar até o projeto criado
cd ../meu-servico-back

# 2. Subir os serviços de infraestrutura localmente
docker compose up -d

# 3. Aplicar as migrations iniciais no banco de dados
npm run migration:run

# 4. Popular as tabelas de lookup (status, prioridade, papéis)
node prisma/seed.mjs

# 5. Iniciar o servidor em modo de desenvolvimento (watch mode)
npm run dev

Endpoints Principais

• API Base: http://localhost:3000/<nome-do-projeto>/api/v1 (o prefixo <nome-do-projeto> vem de API_PREFIX no .env, gerado a partir do nome técnico do projeto)
• Health Check: http://localhost:3000/<nome-do-projeto>/api/health (Público, não exige autenticação)
• Swagger / OpenAPI: http://localhost:3000/api/docs
• Console do Keycloak: http://localhost:8080/auth (Usuário: admin, Senha: admin)

📋 Comandos Disponíveis no package.json