Skip to content

Web Console

Savvas Leousis edited this page Sep 26, 2026 · 2 revisions

Web Console

An Angular trader console in web/. It talks only to the REST API through a typed client generated from web/openapi.json, and works on phones as well as desktops.

flowchart LR
  B[Browser or phone<br/>installable PWA] --> UI[Angular console]
  UI -->|typed client from OpenAPI| API[stonks serve]
Loading

Pages

Page Shows
Dashboard Equity, P&L, drawdown, positions, recent ticks
Strategies Status, survival reports, promote, shadow or retire with confirmation
Lab Launch backtests and lab runs, live progress, equity curves, results
Studio Visual rule builder with live JSON, backtest, lab run, register, enable toggle
Data Coverage, freshness, instruments, ingest runs, trigger an ingest
Orders Orders with rejection reasons, and fills
Shadow Shadow strategies against active ones
Go-live Each go-live check with value and limit
Health The health report and alerts
Settings API token, theme, locale, notifications

Run it

Node 22+ and npm. From web/:

npm install
npm start                   # dev server on http://localhost:4200, proxies /api to 127.0.0.1:8000

In another terminal, from the repo root:

STONKS_API_TOKEN=... uv run stonks serve

npm run build writes web/dist/; stonks serve then serves the console at /, so one process serves both.

Reads are open on loopback, so the console works read-only without a token. Enter STONKS_API_TOKEN in Settings to enable actions (kept for that browser tab only). Behind Caddy, reads need the token too.

Handy features

  • Ctrl+K (or /) opens the command palette: pages, actions, strategies, tickers and recent jobs.
  • Every metric has a "?" tip with one plain sentence, linked to the Glossary.
  • Dark and light themes, keyboard friendly, WCAG 2.2 AA target, locale-aware numbers and dates.
  • Installable as an app. Push notifications are opt-in from Settings; the server routes for push subscriptions are not built yet, so the opt-in stops after the browser permission.

Developer guide: docs/ui.md in the repo.

Clone this wiki locally