Instalação com Docker¶
Esta é a forma recomendada de usar o Dataforge. Requer apenas Docker e Docker Compose instalados.
Pré-requisitos¶
- Docker Engine 24+
- Docker Compose v2+
Nenhuma instalação de Python, Node.js ou dependências adicionais é necessária.
Clonando o repositório¶
Subindo os serviços¶
O build leva alguns minutos na primeira execução pois instala todas as dependências Python e Node.js dentro da imagem.
Após o build, acesse a interface visual em:
Estrutura do docker-compose.yml¶
O arquivo docker-compose.yml define dois serviços:
| Serviço | Container | Uso |
|---|---|---|
frontend |
dataforge-frontend |
Interface visual + servidor de desenvolvimento Vite |
cli |
dataforge-cli |
CLI standalone, acionado via docker compose run |
O serviço cli usa o profile cli e só sobe quando chamado explicitamente com docker compose run --rm cli.
Volumes mapeados¶
volumes:
- ./src/dataforge/schemas:/app/src/dataforge/schemas # schemas editáveis
- ./credentials:/app/credentials # credenciais de nuvem
- ./output:/app/output # arquivos gerados
- ./src/dataforge:/app/src/dataforge # hot reload do código
Hot reload
O código Python e o frontend têm hot reload ativo. Alterações em src/dataforge/ são refletidas imediatamente sem rebuild da imagem.
node_modules
O volume frontend_node_modules protege o node_modules Linux gerado no build. Isso evita conflitos com binários nativos do Windows no host.
Parando os serviços¶
Recriando a imagem¶
Necessário após atualizar dependências em pyproject.toml ou package.json:
Usando o CLI via Docker¶
O CLI é acessado pelo serviço cli. Exemplos:
# Listar domínios disponíveis
docker compose run --rm cli list-domains
# Ver estrutura de um domínio
docker compose run --rm cli schema-info ecommerce
# Gerar dataset
docker compose run --rm cli generate -d ecommerce -f csv
Os arquivos gerados aparecem em output/ no host.