Skip to content
vizier-labPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

webui

The Vizier WebUI: a React Router 7 single-page app on the @vizier/design component library. Vizier embeds its build (build/client/) in the binary and serves it.

It builds inside a vizier checkout: it depends on ../design, the component library submodule. Cloning it on its own won't install.

git clone --recurse-submodules https://github.com/vizier-lab/vizier.git
cd vizier && just install      # submodules, npm i in design/ and webui/, cargo fetch

Develop

just run                       # vizier on :9999 (separate terminal)
cd webui && npm run dev        # the app on http://localhost:5173, proxying /api (and the WebSocket) to :9999

Set VIZIER_URL to proxy to another server.

Script What it does
npm run dev Vite dev server on :5173
npm run build Writes build/client/ (what vizier embeds)
npm run typecheck react-router typegen && tsc
npm test vitest, for app/lib and app/api
npm run e2e Playwright against a running vizier (VIZIER_URL, VIZIER_USER, VIZIER_PASSWORD)
npm run gen:api Regenerates app/api/schema.d.ts from openapi.json; node ../scripts/openapi.mjs fetches the schema from a running server first

Layout

app/routes/ one file per screen, app/screens/<screen>/ the compositions a screen needs, app/layouts/ the shell, app/stores/ Zustand stores, app/lib/ pure logic with its tests, app/api/ the typed client and the topic socket, e2e/ the Playwright suite.

Screens compose library components only, with token utilities and no arbitrary values. A change to a component belongs in design/.

Commit order

A change that needs a new library component goes in three commits, in this order: design/, then webui/, then a vizier commit that bumps both submodule pins.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages