mirror of
https://github.com/harivansh-afk/sandbox-agent.git
synced 2026-04-15 08:03:46 +00:00
64 lines
937 B
Markdown
64 lines
937 B
Markdown
# Contributing
|
|
|
|
## Development Setup
|
|
|
|
1. Clone:
|
|
|
|
```bash
|
|
git clone https://github.com/rivet-dev/sandbox-agent-factory.git
|
|
cd sandbox-agent-factory
|
|
```
|
|
|
|
2. Install dependencies:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
3. Build all packages:
|
|
|
|
```bash
|
|
pnpm -w build
|
|
```
|
|
|
|
## Package Layout
|
|
|
|
- `packages/shared`: contracts/schemas
|
|
- `packages/backend`: RivetKit actors + DB + providers + integrations
|
|
- `packages/cli`: `hf` and `hf tui` (OpenTUI)
|
|
|
|
## Local RivetKit Dependency
|
|
|
|
Build local RivetKit before backend changes that depend on Rivet internals:
|
|
|
|
```bash
|
|
cd ../rivet
|
|
pnpm build -F rivetkit
|
|
|
|
cd /path/to/sandbox-agent-factory
|
|
just sync-rivetkit
|
|
```
|
|
|
|
## Validation
|
|
|
|
Run before opening a PR:
|
|
|
|
```bash
|
|
pnpm -w typecheck
|
|
pnpm -w build
|
|
pnpm -w test
|
|
```
|
|
|
|
## Dev Backend (Docker Compose)
|
|
|
|
Start the dev backend (hot reload via `bun --watch`) and Vite frontend via Docker Compose:
|
|
|
|
```bash
|
|
just factory-dev
|
|
```
|
|
|
|
Stop it:
|
|
|
|
```bash
|
|
just factory-dev-down
|
|
```
|