Tecnologias utilizadas

Crie um arquivo .env na raiz do projeto com a seguinte estrutura:

# Configurações da API
NODE_ENV=production # Ou 'development' para ambiente de desenvolvimento
API_PORT=3000

# Configurações do Banco de Dados
DATABASE_NAME=postgres
DATABASE_USER=postgres
DATABASE_PASSWORD=123
DATABASE_PORT=5432
DATABASE_HOST=db # Ou 'localhost' para ambiente de desenvolvimento

# Segredo JWT
JWT_SECRET=secret

## Inicialização do projeto

```bash
$ npm install

Para acessar o pgAdmin, abra http://localhost:5050 no navegador. A porta padrão está configurada para 5050 no docker-compose.yml, mas pode ser alterada conforme necessário. Utilize as credenciais abaixo:

email: [email protected]
senha: root

Utilize o docker-compose para inicializar os serviços necessários para o projeto.

docker-compose up -d --build # Para reconstruir e iniciar os containers
docker-compose up -d         # Para iniciar os containers
docker-compose down          # Para desligar os containers

Nesse caso não será necessário fazer as migrações do banco de dados, pois o docker-compose já faz isso.

Para visualizar os logs utilize o seguinte comando fora do container. (CTRL+C para sair)

docker logs app-1 -f

Dentro do projeto, você pode utilizar os seguintes comandos:

npm run buid  # Compilar o projeto
npm run dev    # Iniciar em modo desenvolvimento
npm run prod   # Iniciar em modo produção
npm run start  # Iniciar com `nest start`

Para acessar a documentção da API, abra http://localhost:3000/api no navegador.

Para gerenciar migrações do banco de dados:

npm run migration:run        # Executar migrações
npm run migration:generate   # Gerar novas migrações
npm run migration:create     # Criar migração
npm run migration:revert     # Reverter migração
npm run migration:show       # Mostrar migrações

Para adicionar as migrações ao Docker, execute o container temporário:

docker-compose migration

Para executar os testes, utilize o seguinte comando:

npm run test         # Executar testes unitários
npm run test:watch   # Executar testes em modo observação

Para executar o lint, utilize o seguinte comando:

npm run lint