Skip to content

Building from source

The full dev setup for hacking on Kubus itself. If you just want to run Kubus from source, the install guide is shorter.

Requirements

  • Node.js ≥ 22
  • pnpm

Project layout

Kubus is a pnpm workspace:

Package What it is
client/ The React 19 + MUI 7 single-page app (Vite).
server/ The Fastify 5 server — Kubernetes client, watches, exec, port-forward, Helm, metrics.
shared/ Types and metadata shared between client and server.
electron/ The Electron desktop shell.
hack/ Dev scripts, including the test-cluster bootstrap.

Hot-reload dev servers

pnpm install
pnpm dev            # tsx-watch server on :3001 + Vite client on :5173

Open http://localhost:5173 — the Vite dev server proxies /api and /ws to the backend on :3001, so client and server both hot-reload.

Production build

pnpm build          # builds every package
pnpm start          # runs the compiled server and opens your browser

Desktop shell

pnpm electron       # builds everything, then launches Electron
pnpm dist           # packages installers for the current platform → electron/release/

Checks

pnpm typecheck
pnpm lint
pnpm lint:perf     # optional performance audit; reports suggestions without failing

See also