Files
alchemist/docs/contributing/development.md

1.2 KiB

title, description
title description
Development Setup Setting up a local Alchemist development environment.

Prerequisites

  • Rust 1.85+ (rustup update stable)
  • Bun — frontend package manager
  • FFmpeg — required for local testing
  • just — task runner

Node.js is not required. Alchemist uses Bun for all frontend tooling.

Clone and run

git clone https://github.com/bybrooklyn/alchemist.git
cd alchemist
just dev   # build frontend assets, then start the backend

Common tasks

just check          # fmt + clippy + typecheck + build (mirrors CI)
just test           # cargo test
just test-e2e       # Playwright reliability suite
just db-reset       # wipe dev DB, keep config
just db-reset-all   # wipe DB and config (re-triggers wizard)
just bump 0.3.0     # bump version in all files
just update 0.3.0   # full guarded release flow

Frontend only

cd web
bun install --frozen-lockfile
bun run dev         # dev server on :4321
bun run typecheck   # TypeScript check
bun run build       # production build

Backend only

cargo run           # starts on :3000
cargo clippy -- -D warnings
cargo fmt