Configuração do Ambiente

Este guia cobre tudo o que você precisa instalar e configurar para começar a contribuir para o Urbis.

Requisitos do Sistema

• SO: macOS, Linux, ou Windows (via WSL2).
• Node.js: v20.x (LTS recomendado).
• Gerenciador de Pacotes: pnpm v9.x.
• Docker: Docker Desktop ou Docker Engine + Compose.

1. Instalar Node.js & pnpm

Recomendamos usar nvm (Node Version Manager) para instalar o Node.js.

nvm install 20
nvm use 20
corepack enable
corepack prepare pnpm@latest --activate

2. Clonar e Instalar

git clone https://github.com/OpenUrbis/urbis-map.git urbis
cd urbis
pnpm install

3. Variáveis de Ambiente

Copie os arquivos de ambiente de exemplo:

cp apps/api/.env.example apps/api/.env

Revise o .env e atualize os valores se necessário (ex: credenciais do banco de dados se não estiver usando a configuração padrão do Docker).

4. Iniciar Infraestrutura

Execute o comando para iniciar os containers Docker (Postgres, Redis).

pnpm composer:up

5. Verificar Configuração

Execute a API localmente para garantir que tudo se conecte:

cd apps/api
pnpm start:dev

Você deve ver logs do NestJS indicando uma inicialização bem-sucedida.