Skip to content

Commit 96502c7

Browse files
ambvclaude
andcommitted
Consolidate README: local dev section, standardize docker compose
Move Makefile targets into a separate "Local Development (not recommended)" section. Standardize on "docker compose" (space) in all documentation. Add Docker command for populating mock data. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3458f66 commit 96502c7

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,9 @@ npm run lint # Frontend linting (in frontend directory)
4040
npm run typecheck # TypeScript type checking
4141
```
4242

43-
### Database Management
43+
### Populating Mock Data
4444
```bash
45-
make reset-db # Drop and recreate database with fresh data
46-
make populate-db # Add mock benchmark data
47-
```
48-
49-
### Production
50-
```bash
51-
make build # Build frontend for production
52-
make clean # Clean up generated files and caches
45+
docker compose -f docker-compose.dev.yml exec backend python scripts/populate_db.py
5346
```
5447

5548
### Updating Backend Dependencies
@@ -105,6 +98,26 @@ docker compose -f docker-compose.dev.yml up
10598
docker compose up
10699
```
107100

101+
## Local Development (not recommended)
102+
103+
Running services directly on the host is possible but not recommended.
104+
Docker Compose ensures consistent Python/Node versions, database setup,
105+
and dependency isolation across all platforms.
106+
107+
### Prerequisites
108+
- Python 3.13+
109+
- Node.js 20+
110+
111+
```bash
112+
make setup # Install deps, init DB, populate mock data
113+
make dev # Start frontend + backend with hot reload
114+
make test # Run backend tests
115+
make reset-db # Drop and recreate database with fresh data
116+
make populate-db # Populate the DB with mock data
117+
make build # Build frontend for production
118+
make clean # Clean up generated files and caches
119+
```
120+
108121
## Usage Examples
109122

110123
### Analyzing Memory Trends
@@ -138,7 +151,7 @@ memory-tracker benchmark ~/cpython HEAD~10..HEAD \
138151
## Contributing
139152

140153
1. Follow the existing code style and conventions
141-
2. Run tests before committing: `make test`
154+
2. Run tests before committing
142155
3. Use TypeScript for all frontend code
143156
4. Follow the repository patterns for new features
144157
5. Never commit secrets or authentication tokens

0 commit comments

Comments
 (0)