Problem
docker-compose.yml defines three parallel network stacks (db-testnet/api-testnet/indexer-testnet, and the same for mainnet and devnet) plus redis. A contributor who only wants to run the explorer locally has no guidance on which subset of these services to start, which ports they expose, or which environment variables must be set for each.
Combined with the service-name mismatch against the frontend's nginx proxy, getting a working local stack currently requires reading docker-compose.yml and the frontend's nginx configuration side by side.
What needs to be done
- Document a single supported "run the explorer locally" path: the exact compose command/profile, the services it starts, the ports, and the required environment variables.
- Consider adding compose profiles so
docker compose --profile testnet up starts only the testnet stack.
- State clearly which service the frontend must point at (
:3001) and cross-link the frontend repository's setup instructions.
- Verify the documented path works from a clean checkout.
Files
docker-compose.yml
README.md
.env.example
Acceptance deliverables
- A documented, verified command brings up a working local backend for the frontend.
- Ports, services, and required variables are listed.
Tests to pass
- Documented verification from a clean checkout: the stack starts and
/health on the indexer responds.
Problem
docker-compose.ymldefines three parallel network stacks (db-testnet/api-testnet/indexer-testnet, and the same for mainnet and devnet) plusredis. A contributor who only wants to run the explorer locally has no guidance on which subset of these services to start, which ports they expose, or which environment variables must be set for each.Combined with the service-name mismatch against the frontend's nginx proxy, getting a working local stack currently requires reading
docker-compose.ymland the frontend's nginx configuration side by side.What needs to be done
docker compose --profile testnet upstarts only the testnet stack.:3001) and cross-link the frontend repository's setup instructions.Files
docker-compose.ymlREADME.md.env.exampleAcceptance deliverables
Tests to pass
/healthon the indexer responds.