Skip to content

README.md

Latest commit

 

History

History
63 lines (42 loc) · 1.89 KB

README.md

File metadata and controls

63 lines (42 loc) · 1.89 KB
Raw

Rook Dashboard

The Rook management dashboard is a Vue 3 SPA, embedded in the production Rook binary under /dashboard/. Vite serves it on port 4747 and proxies API requests to the backend on port 3773 by default.

Requirements

  • Node.js and pnpm (version pinned in the root package.json)
  • A running Rook backend for authenticated management flows and API data

Install workspace dependencies with pnpm install from the repository root.

Local development

Start Rook, then start Vite from the repository root:

just run-dashboard

Open http://localhost:4747/dashboard/. The dev server proxies /api/, /health, and authentication requests to http://127.0.0.1:3773.

To use another backend or base path, set API_TARGET or BASE_PATH when running Vite. For example:

cd apps/rook/dashboard
API_TARGET=http://127.0.0.1:8081 pnpm dev

Checks

From apps/rook/dashboard/, run:

pnpm typecheck && pnpm build && pnpm exec vitest run

just ci-local runs the dashboard checks as part of the workspace quality gate.

End-to-end tests

Playwright tests in e2e/ cover login, providers, API keys, and dashboard flows. The Docker-backed workflow prepares the backend, admin account, and dashboard:

just test-e2e

See the dev test guide for manual runs and browser installation.

Structure and configuration

Pages live in src/views/, shared UI in src/components/, routing in src/router/, Pinia state in src/stores/, and English/Spanish translations in src/locales/. vite.config.ts defines the base path and proxy; playwright.config.ts defines browser projects and E2E settings.

See the Rook configuration guide, API reference, and workspace README for backend setup and product context.