Docker based local development environment with seed data and contracts deployed to anvil#1693
Docker based local development environment with seed data and contracts deployed to anvil#1693
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📊 Test Coverage Report
|
a010e6b to
6e9868b
Compare
6e9868b to
f0e521a
Compare
f0e521a to
753b1f2
Compare
753b1f2 to
395f222
Compare
55cc8a6 to
9917c46
Compare
| - api: the api server and metrics server available on the host machine via API_PORT (default 3000) and METRICS_PORT (default 3003) | ||
| - comps: the next.js server available via COMPS_PORT (default 3001) | ||
|
|
||
| See `.env.example` for the full list of env vars |
There was a problem hiding this comment.
| See `.env.example` for the full list of env vars | |
| See `.env.docker-compose.example` for the full list of env vars |
The README references .env.example but the actual file is named .env.docker-compose.example.
View Details
Analysis
Incorrect environment file reference in README Local Development Setup section
What fails: README.md line 145 references .env.example in the "Local Development Setup" section, but this file does not exist in the repository root.
How to reproduce:
- Clone the repository
- Read the "Local Development Setup" section in README.md
- Attempt to find
.env.exampleat the repository root - File not found; the actual file is
.env.docker-compose.example
Result: Users following the documentation cannot find the referenced file and are confused about which environment file to reference for the docker-compose setup.
Expected behavior: The README should reference .env.docker-compose.example, which is the actual environment file present at the repository root and relevant to the docker-compose setup.
Verification: Repository root contains .env.docker-compose.example (confirmed with ls -la .env*), not .env.example. The .env.example files exist only in subdirectories (apps/api/.env.example, apps/comps/.env.example, etc.) but are not relevant to the docker-compose local development setup.
This grew a bit in size over the course of the break. Sorry that it's a bit bigger, and might be harder to review. Of note: the contracts submodule has a required PR as well: recallnet/recall-staking-contracts#16
You must checkout this branch and update submodules for this all to work locally.
Instructions for running are in the LOCAL_DOCKER_DEV.md,
TL;DR;
Set the .env correctly and do:
docker compose builddocker compose --profile comps upcd apps/comps && npm run devImplements:
https://linear.app/recall-labs/issue/ENG-1148/deploy-all-smart-contracts
https://linear.app/recall-labs/issue/ENG-1141/seed-database-with-test-data
https://linear.app/recall-labs/issue/ENG-1147/trigger-crons
https://linear.app/recall-labs/issue/ENG-1143/seed-smart-contracts-with-dataevents