scriptoriumadmin/OpenSpace
1
0
Fork 0
mirror of https://github.com/HKUDS/OpenSpace.git synced 2026-09-22 00:31:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
OpenSpace/frontend
History
who96 efd020317c docs: apply PR1 dashboard install review fixes
2026-03-27 10:25:52 +08:00
..
public initial commit 2026-03-24 16:03:22 +08:00
src initial commit 2026-03-24 16:03:22 +08:00
.env.example initial commit 2026-03-24 16:03:22 +08:00
index.html initial commit 2026-03-24 16:03:22 +08:00
package-lock.json initial commit 2026-03-24 16:03:22 +08:00
package.json initial commit 2026-03-24 16:03:22 +08:00
postcss.config.js initial commit 2026-03-24 16:03:22 +08:00
README.md docs: apply PR1 dashboard install review fixes 2026-03-27 10:25:52 +08:00
tailwind.config.js initial commit 2026-03-24 16:03:22 +08:00
tsconfig.json initial commit 2026-03-24 16:03:22 +08:00
tsconfig.node.json initial commit 2026-03-24 16:03:22 +08:00
vite.config.ts initial commit 2026-03-24 16:03:22 +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 frontend
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. Install the OpenSpace Python package from the repo root into the same Python environment that will run the backend:
cd ..
python -m pip install -e .
  1. Verify both backend entry points from that same activated Python environment:
openspace-mcp --help
openspace-dashboard --help

If the console scripts are still unavailable on PATH, verify the module entry points from the repo root instead:

python -m openspace.mcp_server --help
python -m openspace.dashboard_server --help
  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.dashboard_server --host 127.0.0.1 --port 7788

Requires Python ≥ 3.12 with flask installed.

If openspace-dashboard is not on PATH, use option B. On Windows, make sure the same virtual environment is activated before running either command.

  1. Start the frontend
cd 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, frontend dependencies are installed, and the OpenSpace package is installed in your active Python environment, you only need:

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

# fallback if the console script is unavailable
python -m openspace.dashboard_server --host 127.0.0.1 --port 7788

# terminal 2 – frontend
cd frontend
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 frontend
npm run build

After building, start the backend and it will serve frontend/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