Skip to content

[Good First Issue] Improve local development setup #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YuuGR1337 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Good First Issue] Improve local development setup #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,33 @@ The platform is designed to be built incrementally through vertical slices:

## Quickstart & Local Setup

### Prerequisites

- **Rust 1.80+**, **Node.js 18+**, **Docker** (for Redis & PostgreSQL)

### Local Development Setup

```bash
# 1. Start state services
docker run -d --name redis -p 6379:6379 redis:7
docker run -d --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=dev postgres:16

# 2. Build and run the control plane
cargo build && cargo run

# 3. Start the frontend
cd frontend && npm install && npm run dev

# 4. Run tests
cargo test && python tests/test_phase3_correlation.py
```

### Troubleshooting

- **Port conflicts:** Ensure 6379, 5432, 3000 are free (`lsof -i :<port>`).
- **DB connection errors:** Verify PostgreSQL is running and `DATABASE_URL` is set in `.env`.
- **Frontend won't start:** Delete `node_modules` and re-run `npm install`.

### 1. Prerequisites
- **Rust**: 1.80+ (`stable` toolchain)
- **Node.js**: 20+ and npm
Expand Down