Pular para o conteúdo principal

Setup do Ambiente

Para quem é esta página

Qualquer pessoa que quer rodar o CARla localmente — dev, QA ou PM técnico.

Pré-requisitos​

FerramentaVersão mínimaInstalação
Python3.13+python.org ou pyenv
Node.js20+nvm
Docker24+docker.com
Docker Compose2.20+Incluído no Docker Desktop
uvlatestcurl -LsSf https://astral.sh/uv/install.sh | sh
git2.40+—

Quick Start (5 comandos)​

# 1. Clonar e entrar no projeto
git clone [email protected]:gresas/carla-cadastro-rural.git && cd carla-cadastro-rural

# 2. Subir infraestrutura (PostgreSQL+PostGIS, Redis, RabbitMQ, MinIO)
docker compose up -d

# 3. Backend: instalar deps, criar .env e aplicar migrations
cd backend && uv sync && cp ../.env.example .env && make migrate && make seed-dev

# 4. Iniciar o backend
make dev
# API docs: http://localhost:8000/api/docs

# 5. Frontend (em outro terminal)
cd ../frontend && npm install && npm run dev
# App: http://localhost:3000

Documentação (este site)​

cd website && npm install && npm run start
# Docusaurus: http://localhost:3001

Variáveis de Ambiente​

Copie .env.example e edite conforme necessário:

# Database
DATABASE_URL=postgresql+asyncpg://carla:password@localhost:5432/carla_dev

# LLM (apenas uma é necessária para dev)
ANTHROPIC_API_KEY=sk-ant-...
LLM_PRIMARY_PROVIDER=anthropic

# Gov.br (mock habilitado por padrão em dev)
GOVBR_MOCK_ENABLED=true
Gov.br em desenvolvimento

GOVBR_MOCK_ENABLED=true ativa um login simplificado (CPF + nome) sem necessidade de integração real com o Gov.br. Ideal para desenvolvimento local.

Comandos úteis​

# Backend
make dev          # Iniciar com hot-reload
make test         # Rodar testes unitários + integração
make lint         # ruff + mypy
make migrate      # Aplicar migrations pendentes
make seed-dev     # Popular banco com dados de teste

# Frontend
npm run dev       # Dev server com HMR
npm run build     # Build de produção
npm run test      # Vitest

# Docusaurus
npm run start     # Dev server
npm run build     # Build estático

Ver também​