Skip to content

fix: corrige conflitos de configuração e documenta execução com Docker#5

Merged
LuGodoy merged 2 commits into
LuGodoy:developfrom
RegiMaria:fix/env-example-readme
May 25, 2026
Merged

fix: corrige conflitos de configuração e documenta execução com Docker#5
LuGodoy merged 2 commits into
LuGodoy:developfrom
RegiMaria:fix/env-example-readme

Conversation

@RegiMaria
Copy link
Copy Markdown
Contributor

O que muda

Corrige conflitos e lacunas que impediam novos contribuidores de
rodar o projeto do zero.

Problemas corrigidos

1. Conflito entre docker-compose.yml e .env.example
O .env.example tinha DB_HOST=localhost e DB_NAME=db_finance, mas o
docker-compose sobe com DB_HOST=db e DB_NAME=personal_finance.
Quem copiava o .env.example sem ajustar não conseguia conectar.

2. Instruções de execução incompletas no README
Não havia documentação do fluxo com Docker. Novo contribuidor
precisava descobrir os passos por tentativa e erro.

3. make env sobrescrevia o .env.example
O comando regenerava o .env.example com valores desatualizados,
desfazendo qualquer melhoria no arquivo.

Arquivos alterados

  • .env.example — credenciais alinhadas com o docker-compose,
    comentários explicando Docker vs MySQL local, link para obter
    a chave do Gemini
  • README.md — seção "Como Executar" reescrita com duas opções:
    Docker (recomendado) e MySQL local
  • Makefile — comando make env corrigido para apenas copiar
    o .env.example existente, sem sobrescrever

Como testar

docker compose up -d
cp .env.example .env
# preencher GEMINI_API_KEY
make install
make run

Copy link
Copy Markdown
Owner

@LuGodoy LuGodoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boa evolução nesse PR @RegiMaria👏
Os ajustes no .env.example e no README resolveram pontos importantes de onboarding e deixaram o setup mais consistente com o docker-compose.
Também gostei da preocupação em evitar sobrescrita no make env, porque isso melhora bastante a experiência para novos contribuidores.
Próximos gaps que ainda podemos trabalhar no projeto:
adicionar um CONTRIBUTING.md com fluxo de contribuição
documentar como rodar os testes com Docker
explicar melhor o contexto do make mcp
revisar o LOG_LEVEL, porque hoje a variável existe mas ainda não tem efeito no código.
Continue nessa linha de pequenas melhorias incrementais e PRs focados 👍

@LuGodoy LuGodoy merged commit 1b9ac2b into LuGodoy:develop May 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants