Skip to content

docs: add Docker Compose dev setup and local development guide#7

Open
harmeshgv wants to merge 3 commits intoagentmecz:mainfrom
harmeshgv:docs/local-development-guide
Open

docs: add Docker Compose dev setup and local development guide#7
harmeshgv wants to merge 3 commits intoagentmecz:mainfrom
harmeshgv:docs/local-development-guide

Conversation

@harmeshgv
Copy link

@harmeshgv harmeshgv commented Feb 16, 2026

Summary

Adds a developer-friendly local development setup including:

  • docker-compose.dev.yml with clean defaults
  • .env.example with documented required variables
  • docs/guides/local-development.md step-by-step guide

Improves onboarding by making the full local stack reproducible and beginner-friendly. ISSUE NO #3

Changes

  • Added docker-compose.dev.yml with proper service order:

    • anvil → deploy → node + bridge
  • Added .env.example with documented environment variables

    • Clarified that BRIDGE_API_TOKEN is mandatory for Bridge startup
  • Added docs/guides/local-development.md with:

    • Prerequisites
    • Setup instructions
    • Startup flow explanation
    • Service ports
    • Common issues
    • Clean restart test section

Test Plan

  • Unit tests pass (make test)
  • Lint passes (make lint)
  • Relevant new tests added

Checklist

  • Code follows project conventions
  • No secrets or credentials included
  • Documentation updated if needed

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.

1 participant