scriptoriumadmin/OpenSpace
1
0
Fork 0
mirror of https://github.com/HKUDS/OpenSpace.git synced 2026-08-28 05:15:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
OpenSpace/apps/dashboard
History
Exact
spidercatfly fadc4bccab
v2 initial commit
2026-07-17 11:43:42 +08:00
..
public v2 initial commit 2026-07-17 11:43:42 +08:00
src v2 initial commit 2026-07-17 11:43:42 +08:00
.env.example v2 initial commit 2026-07-17 11:43:42 +08:00
index.html v2 initial commit 2026-07-17 11:43:42 +08:00
package-lock.json v2 initial commit 2026-07-17 11:43:42 +08:00
package.json v2 initial commit 2026-07-17 11:43:42 +08:00
postcss.config.js v2 initial commit 2026-07-17 11:43:42 +08:00
README.md v2 initial commit 2026-07-17 11:43:42 +08:00
tailwind.config.js v2 initial commit 2026-07-17 11:43:42 +08:00
tsconfig.json v2 initial commit 2026-07-17 11:43:42 +08:00
tsconfig.node.json v2 initial commit 2026-07-17 11:43:42 +08:00
vite.config.ts v2 initial commit 2026-07-17 11:43:42 +08:00

README.md

OpenSpace Frontend

A dashboard frontend for the OpenSpace, providing skill browsing, lineage visualization, and workflow inspection.

Prerequisites

  • Node.js ≥ 20

First-time Setup

  1. Copy the environment file
cd apps/dashboard
cp .env.example .env

Edit .env if your backend runs on a different host/port:

VITE_HOST=127.0.0.1
VITE_PORT=3888
VITE_API_PROXY_TARGET=http://127.0.0.1:7788
VITE_API_BASE_URL=/api/v1
  1. Install dependencies
npm install
  1. Start the backend (in a separate terminal)
# option A – CLI entry point
openspace-dashboard --host 127.0.0.1 --port 7788

# option B – from the repo root
python -m openspace.entrypoints.dashboard.server --host 127.0.0.1 --port 7788

Requires Python ≥ 3.12 with flask installed.

  1. Start the frontend
npm run dev

The dev server will be available at http://127.0.0.1:3888 (or whatever VITE_PORT you set).

Subsequent Starts

Once .env is configured and dependencies are installed, you only need:

# terminal 1 – backend
openspace-dashboard --host 127.0.0.1 --port 7788

# terminal 2 – frontend
cd apps/dashboard
npm run dev

Default URLs

Service URL
Frontend dev server http://127.0.0.1:3888
Dashboard API http://127.0.0.1:7788

Advanced Configuration

Bypass the Vite proxy

If you prefer to call the backend directly (e.g. for debugging), you can set VITE_API_BASE_URL to the full backend URL:

VITE_API_BASE_URL=http://127.0.0.1:7788/api/v1 npm run dev

Production Build

cd apps/dashboard
npm run build

After building, start the backend and it will serve apps/dashboard/dist as static files automatically — no need to run the dev server.

Main Pages

  • Dashboard – overall health, pipeline stages, top skills, recent workflows
  • Skills – searchable skill list and score breakdown
  • Skill Detail – source preview, lineage graph, scoring metrics, recent analyses
  • Workflows – recorded workflow sessions from logs/recordings and logs/trajectories
  • Workflow Detail – timeline, artifacts, metadata, selected skills, plans, and decisions