Começando rápido (demo local)¶

Como testar o sistema rapidamente?¶

Este guia é só para ver o DSP funcionando na sua máquina: sobe uma demo local com seed sintético do Brasil (dados de exemplo no mapa), sem conectar nenhum banco da sua organização. Você navega no site, explora filtros, KPIs e o mapa — é o caminho mais rápido para conhecer a interface, não para publicar ou migrar dados reais.

Pré-requisito¶

O dsp-core orquestra o build dos demais módulos via Docker. Se faltar algum repositório irmão, os scripts oferecem clonar automaticamente

Passo 1 — Organizar os repositórios¶

O DSP é dividido em repositórios irmãos no GitHub. Recomendamos criar uma pasta dsp e clonar tudo no mesmo nível.

Os scripts procuram cada módulo nesta ordem: primeiro a pasta curta (backend, frontend, job-data-migration, job-geo-file-generation) e, se o código não estiver lá, a pasta com o nome do repositório (dsp-backend, dsp-frontend, dsp-job-data-migration, dsp-job-geo-file-generation). Se as duas faltarem, o download automático cria a pasta com o nome do repositório. A publicação automática no CI continua usando a pasta curta.

Opção A — fluxo mais simples (recomendado)¶

Crie a pasta, clone só o core e entre nele. Os scripts ./config.sh, ./setup.sh e ./start.sh detectam repositórios irmãos ausentes e oferecem cloná-los automaticamente ao lado do core:

mkdir dsp && cd dsp
git clone https://github.com/Rural-Environmental-Registry/dsp-core.git
cd dsp-core

Depois que você aceitar o clone automático nos scripts, a árvore típica fica assim:

dsp/
├── dsp-core/          ← você trabalha aqui (config.sh, setup.sh, start.sh)
├── dsp-backend/
├── dsp-frontend/
├── dsp-job-data-migration/
└── dsp-job-geo-file-generation/

Opção B — clone manual¶

Clone todos os repositórios de aplicação como pastas irmãs dentro de dsp:

mkdir dsp && cd dsp
git clone https://github.com/Rural-Environmental-Registry/dsp-core.git
git clone https://github.com/Rural-Environmental-Registry/dsp-backend.git
git clone https://github.com/Rural-Environmental-Registry/dsp-frontend.git
git clone https://github.com/Rural-Environmental-Registry/dsp-job-data-migration.git
git clone https://github.com/Rural-Environmental-Registry/dsp-job-geo-file-generation.git

Resultado:

dsp/
├── dsp-core/
├── dsp-backend/
├── dsp-frontend/
├── dsp-job-data-migration/
└── dsp-job-geo-file-generation/

Passo 2 — Entrar no core¶

Se você ainda não estiver dentro do core:

cd dsp/dsp-core

Os scripts do core criam o .env na primeira vez que você rodar o setup — não precisa criar esse arquivo manualmente.

Passo 3 — Rodar o setup em modo demo¶

./setup.sh

No menu Step 3/11 — Setup mode, escolha 1 — o texto exibido pelo script é:

  1) Demonstration (built-in Brazil seed, no JDBC)
     Loads demo map data from built-in SQL — no source database or migration job.
     Use when exploring the UI, evaluating the stack, or when you do not have adopter data yet.

Isso prepara os bancos locais (dsp-db, dsp-geoserver-db), publica as camadas nos GeoServers (Exhibition + Download) e aplica o seed de demonstração. Não conecta ao banco de origem da sua organização (nenhuma fonte JDBC externa) e não sobe o job de migração — os dados vêm só do SQL de exemplo embutido no core.

Aguarde o ./setup.sh terminar por completo (todas as etapas até o fim, com mensagem de sucesso no terminal). Só então passe ao Passo 4 — interromper no meio deixa bancos ou GeoServer incompletos.

Passo 4 — Subir os demais componentes¶

./start.sh

O ./setup.sh já deixou prontos bancos, GeoServers e dados de demo. O ./start.sh sobe o restante da stack — API (backend), site (frontend) e gateway nginx (porta única de acesso) — usando o que já está nos bancos. Ele não roda de novo o seed nem o job de migração; serve para ligar a interface e a API depois que a base geográfica já foi carregada.

Espere o ./start.sh concluir antes de abrir o navegador.

Passo 5 — Acessar o sistema¶

Com o ./start.sh finalizado e os containers no ar, abra no navegador http://localhost:8026/dsp/ (ou a URL exibida no passo 5 do ./start.sh se você alterou porta/host no .env):

Legenda: mesma tela da consulta pública, rodando localmente depois do ./start.sh (gateway na porta configurada, em geral http://localhost:8026/dsp/).

Próximos passos¶