Prerequisites
- bun — the package manager (note
bun.lock; don’t use npm or yarn) - The Rust toolchain — the repository pins its version, including
rustfmtand Clippy, inrust-toolchain.toml git- Your platform’s Tauri system dependencies — webkit2gtk on Linux, Xcode Command Line Tools on macOS, MSVC Build Tools + WebView2 on Windows
Build
bun install
bun run tauri buildSource builds don’t use the in-app updater — pull and rebuild to update. They also don’t trip any signing warnings, because you compiled the binary yourself.
Develop
bun run tauri dev # launch the app with hot reloadChecks
bunx tsc --noEmit # typecheck
bun run test # vitest (node + happy-dom projects)
bun run lint # eslintcd src-tauri
cargo check
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warningsTypechecks are the primary safety net — test coverage is still partial.
Contributing
Bug reports and feature requests are welcome in
issues. See
CONTRIBUTING.md
to get started, and the architecture rules in
docs/rules/ for
the conventions that keep changes consistent.