diff --git a/README.md b/README.md index f25f710b2..2cc6f2d18 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,14 @@ those checks in cached, parallel jobs with sharded browser journeys. Install the fast staged-file pre-commit and related-test pre-push hooks once per worktree with `bin/pnpm hooks:install`; see [hook behavior and partial staging](docs/contributing.md#git-hooks). +### Design system + +Run `just design` (or `bin/just design` without activation) to install locked +dependencies, start the standalone design-system viewer, and open it in your +browser. It uses port 1442 and does not start the desktop app or live relay broker. +If that port is occupied, choose another with `just design --port 1444`. +Press Ctrl+C to stop the server. + ## Relay channels Live development currently requires **an existing Buzz account in the OS credential diff --git a/docs/contributing.md b/docs/contributing.md index 9ede80cdd..a40c9cf99 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -58,6 +58,11 @@ need their own validation. implicit runner arguments. Explicit `--config` arguments merge afterward and can override it; keep their development URL and frontend command consistent. Use `--` before runner/application arguments if they contain their own `--port` flag. +- `just design [args...]`: install locked dependencies, start the standalone + design-system viewer, and open it in your browser. Arguments pass through to + Vite, e.g. `just design --port 1444`. The default port is 1442; an occupied port + fails rather than switching automatically. This starts neither Tauri nor the + live relay broker. Press Ctrl+C to stop it. - To pause notifications in your local dev server, set `BUZZ_DEV_NOTIFICATIONS=0` in `.env.local` and restart the server. Only `0` pauses alerts and permission requests; removing the setting restores normal behavior. Saved preferences are diff --git a/justfile b/justfile index 9e1993cf3..4d5959e9f 100644 --- a/justfile +++ b/justfile @@ -18,6 +18,11 @@ web *args: install desktop *args: install node scripts/desktop-dev.mjs "$@" +# Open the design system in a browser; forward Vite arguments (e.g. --port 1444). +[positional-arguments] +design *args: install + pnpm design:dev "$@" + # Run buzzodz; forward arguments unchanged (Rust required). [positional-arguments] cli *args: