mirror of
https://github.com/HKUDS/OpenSpace.git
synced 2026-08-28 05:15:00 +00:00
98 lines
2.3 KiB
Markdown
98 lines
2.3 KiB
Markdown
# 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**
|
||
|
||
```bash
|
||
cd apps/dashboard
|
||
cp .env.example .env
|
||
```
|
||
|
||
Edit `.env` if your backend runs on a different host/port:
|
||
|
||
```dotenv
|
||
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
|
||
```
|
||
|
||
2. **Install dependencies**
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
3. **Start the backend** (in a separate terminal)
|
||
|
||
```bash
|
||
# 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.
|
||
|
||
4. **Start the frontend**
|
||
|
||
```bash
|
||
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:
|
||
|
||
```bash
|
||
# 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:
|
||
|
||
```bash
|
||
VITE_API_BASE_URL=http://127.0.0.1:7788/api/v1 npm run dev
|
||
```
|
||
|
||
## Production Build
|
||
|
||
```bash
|
||
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
|