VIK Solenoid

BoardStudio

BoardStudio is an offline-capable keyboard design workbench built with Dioxus and Rust. It combines layouts, PCB preparation, keymaps, keycaps, mechanical assemblies and portable exports. KiCad and CAD tools handle downstream routing and fabrication.

Development

Install the Rust version in rust-toolchain.toml, wasm-pack 0.15.0, Dioxus CLI 0.7.10 and Python 3.11+. No Node, npm or pnpm is needed. KiCad CLI 10 is required for PCB integration checks. Browser tests require Chrome/Chromium and its compatible ChromeDriver.

python3 scripts/dev-web.py

The development server runs at http://127.0.0.1:8080/. It builds missing runtime providers on the first run, then Dioxus watches page edits in the working tree. Edits that only change rsx! markup are hot-reloaded without recompiling; other Rust edits rebuild the page. The page builds with the wasm-dev profile in Cargo.toml, which keeps line tables only; set debug = true there to inspect variables in the browser debugger, at roughly twice the rebuild time. Commits, agent registration and migration records are not required. After changing a worker, bundled example or CAD provider, run python3 scripts/build-web.py --providers-only to regenerate those assets before testing the page.

Build and preview

python3 scripts/build-web.py
python3 scripts/serve-web.py web/target/site 4173

The build creates web/target/site/site-subpath/boardstudio, the /boardstudio/ route GitHub Pages publishes. Add --routes subpath,root to also package the root route in web/target/site/site-root. Preview serves the built routes at http://127.0.0.1:4173/ (redirecting / to /boardstudio/ when only the subpath was built) with the isolation headers required by browser workers. Production build and preview are separate from the watched development loop. Development uses an online server; use the production preview to test offline behavior.

The normal Dioxus service worker supports offline use and application updates. React, its deployment handoff and rollback tooling are retired. Version 1 projects migrate to document format version 2 when loaded; current projects save locally and round-trip through .boardstudio exports. Existing user files are never erased by build or cleanup commands.

Checks

python3 scripts/check.py

This runs documentation link checks, build and content tool tests, rustfmt and Clippy, native Rust and provider tests, WASM page compilation, release packaging, native/WASM boundary checks and mounted headless browser tests. Name steps (python3 scripts/check.py --list) to run only the affected checks during development. The browser runner checks that every listed test actually executes, grouped into broad batches to avoid repeated WASM/browser startup costs. Each presentation crate under web/crates/ runs its own browser tests (wasm-pack test --headless --chrome web/crates/<crate> --lib); the Case workspace, panel and setup guide tests run separately because their mounted fixtures need an isolated DOM. Each batch has a bounded two-minute timeout, overridable with WASM_BINDGEN_TEST_TIMEOUT. A native test run alone does not compile WASM-only presentation code. Browser setup installs the locked wasm-bindgen runner before executing tests.

Source layout

The Rust crates share one Cargo workspace (root Cargo.toml, Cargo.lock and target/), so dependencies compile once per profile and target. cad/wasm and cad/step-oracle stay outside it because they build against the pinned WASI and native OCCT toolchains.

The repository has no TypeScript or Node dependency; Python scripts handle build, content preparation and checks. Footprint generation runs in Rust inside Core and the page. User-supplied JavaScript generators are not executed. Bundled model export includes used assets; missing or unsupported model paths fail explicitly.

See architecture, domain vocabulary, component onboarding and deferred issues. Migration history is preserved in Git at 323967ff; it imposes no development or acceptance process on this branch. The documentation index links feature references, investigations, design decisions and historical research.