Primeiros passos

Guia rápido para começar a trabalhar no Busca-Busca — seja lendo a documentação, seja subindo o ambiente local.

1. Entenda o projeto (10 min)

Leia nesta ordem:

1. Objetivo e escopo — o problema e a fronteira do produto.
2. Visão geral da arquitetura — as camadas e o fluxo.
3. Regras de negócio — o coração do domínio.

2. Fluxo docs-first

Este é um projeto docs-first: primeiro documentamos, depois codamos.

• Decisão técnica nova? Registre um ADR.
• Regra de negócio nova? Documente em Domínio antes de implementar.
• Integração nova? Defina o contrato primeiro (API-first).
• Convenções de escrita e commits em CONTRIBUTING.

3. Suba o ambiente local (quando o código existir)

O ambiente de desenvolvimento é Docker Compose (detalhes em Desenvolvimento (Docker)).

git clone <repo-da-aplicacao> busca-busca
cd busca-busca
cp .env.example .env        # ajuste as variáveis (ver Configuração & segredos)
docker compose up -d        # sobe db, rabbitmq, redis, backend, collector, frontend
docker compose logs -f backend

Serviços úteis no dev:

Serviço	URL padrão
Frontend (Angular)	http://localhost:4200 (ou via Nginx)
API (Java)	http://localhost:8080/api
RabbitMQ management	http://localhost:15672
Postgres	localhost:5432

Variáveis e segredos: ver Configuração & segredos.

4. Como isso vai para produção

Push no repo de aplicação → CI (testes, SonarQube, Trivy) → imagem no Harbor → bump no repo GitOps → Argo CD sincroniza no k3s. Ver CI/CD e Kubernetes & GitOps.

Próximos passos

• Produto: Requisitos · Features
• Serviços: Backend · Collector · Frontend

Ver também: Roadmap · Glossário.