Skip to content

Agent: Add a Local development section to README and keep CI green. #208

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

Closed
malon64 wants to merge 1 commit into from
Closed

Agent: Add a Local development section to README and keep CI green. #208

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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,36 @@ If Homebrew is unavailable:
More CLI details: [docs/cli.md](docs/cli.md)
Full installation guide: [docs/installation.md](docs/installation.md)

## Local development

Prerequisites:
- Rust stable toolchain (`rustup toolchain install stable`)
- A C/C++ toolchain available in `PATH`

Build and run from this repo:

```bash
cargo build --all
cargo run -p floe-cli -- --help
```

Run checks before opening a PR:

```bash
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings
```

Run tests:

```bash
cargo test -p floe-core --test unit
cargo test -p floe-core --test integration
cargo test -p floe-cli --tests
```

For orchestrators (Dagster + Airflow) local setup, see [orchestrators/LOCAL_DEV.md](orchestrators/LOCAL_DEV.md).

## Run with Docker

### Pull
Expand Down