Building from Source

Prerequisites

• Rust (2024 edition) — Install Rust
• pnpm — Install pnpm (for the dashboard UI)

Build Steps

# Clone the repository
git clone https://github.com/frectonz/penny.git
cd penny

# Build the dashboard UI
cd ui && pnpm install && pnpm build && cd ..

# Build penny
cargo build --release

The binary will be at target/release/penny.

Development

For development with hot reload:

# Run in debug mode
cargo run -- serve penny.toml

Project Structure

• src/ — Rust source code (proxy, config, API, CLI)
• ui/ — Dashboard web UI (built with pnpm)
• docs/ — Documentation site (Fumadocs + Next.js)