Skip to content

Document Docker Compose Setup for Full Local Stack #1196

Description

@miss-yusrah

Labels: documentation 200pts

Background:
docker-compose.yml exists but there's no guide for running the complete local development stack (contract + backend + frontend + local Stellar network). New contributors spend hours debugging the setup.

Problem:
Contributors can run each service individually but not together. The Docker Compose file has services but no documentation on which to start first, what environment variables are required, how to connect Freighter to a local network, and how to deploy the contract to the local node.

What "Done" Looks Like:

  • New docs/guides/LOCAL_STACK.md
  • Prerequisites: Docker, Docker Compose, Freighter extension configured for custom network
  • Step-by-step: docker compose up → local Stellar node available → deploy contract → fund test accounts → run backend → run frontend
  • Environment variable reference table: which service needs which variables, where defaults come from
  • Contract deployment script: how to deploy to the local Stellar node and get the contract address
  • Freighter custom network setup: how to add http://localhost:8000 as a custom network in Freighter
  • Troubleshooting: "port already in use", "contract deployment fails", "Freighter can't connect to local node"
  • Resetting the local stack: how to wipe all state and start fresh

Key Files to Reference:

  • docker-compose.yml
  • backend/.env.example
  • frontend/.env.example
  • README.md

Constraints:

  • All commands verified on a clean Docker environment
  • Docker Compose version requirements specified
  • Local Stellar node setup uses stellar-cli network start if available

PR Must Include:

  • docs/guides/LOCAL_STACK.md (min 2000 words)
  • Any missing .env.example entries discovered during documentation
  • Troubleshooting section with at least 5 common issues

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions