Skip to content

Docker based local development environment with seed data and contracts deployed to anvil#1693

Open
joewagner wants to merge 20 commits intomainfrom
joe/local-dev
Open

Docker based local development environment with seed data and contracts deployed to anvil#1693
joewagner wants to merge 20 commits intomainfrom
joe/local-dev

Conversation

@joewagner
Copy link
Contributor

@joewagner joewagner commented Dec 23, 2025

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 build
docker compose --profile comps up
cd apps/comps && npm run dev

Implements:
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

@vercel
Copy link
Contributor

vercel bot commented Dec 23, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
comps Ready Ready Preview, Comment Jan 12, 2026 9:27pm

@github-actions
Copy link
Contributor

github-actions bot commented Dec 23, 2025

📊 Test Coverage Report

Package Lines Statements Functions Branches
apps/api 2.51% 2.51% 43.70% 51.74%
apps/comps 0.27% 0.27% 38.00% 40.04%
packages/conversions 100.00% 100.00% 100.00% 100.00%
packages/db 1.70% 1.70% 20.38% 32.97%
packages/rewards 100.00% 100.00% 100.00% 100.00%
packages/services 51.29% (-0.08%) 51.29% (-0.08%) 65.02% (+0.15%) 79.54% (+0.27%)
packages/staking-contracts 100.00% 100.00% 100.00% 100.00%

- 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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:

  1. Clone the repository
  2. Read the "Local Development Setup" section in README.md
  3. Attempt to find .env.example at the repository root
  4. 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.

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