# mskcc/voyager-operation-dashboard architecture

> Architecture diagram of the GitHub repository mskcc/voyager-operation-dashboard, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mskcc/voyager-operation-dashboard
- Repository: https://github.com/mskcc/voyager-operation-dashboard

## Overview

Voyager is an operations dashboard for viewing Beagle pipeline runs, file counts, run-health summaries, and signing in. The React app routes users to protected home, runs, and files pages; those pages fetch Beagle data through a shared authenticated client, then render tables, charts, and summaries. A separate Django API exposes job records backed by Django models; the README documents PostgreSQL synchronization. The sampled code supports the frontend-to-Beagle calls and Django API wiring; it does not show those systems connected to each other.

Main entry points: [`voyager-operation-dashboard/src/App.js`](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/App.js) (App Routing), [`voyager-operation-dashboard/src/components/common/Beagle.js`](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/Beagle.js) (Beagle Client), [`voyager-operation-dashboard/src/pages/home/Home.js`](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/home/Home.js) (Home Dashboard), [`voyager-operation-dashboard/src/pages/runs/Runs.js`](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/runs/Runs.js) (Runs Browser)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Dashboard UI"]
  node_app["App Routing<br/>[App.js]"]
  node_navigation["Navigation<br/>[Navigation.js]"]
  node_protected["Route Guard<br/>[Protected.js]"]
  node_login["Login<br/>[Login.js]"]
  node_home["Home Dashboard<br/>[Home.js]"]
  node_runs["Runs Browser<br/>[Runs.js]"]
  node_files["Files View<br/>[Files.js]"]
end

subgraph group_beagle["Beagle Integration"]
  node_beagle_client["Beagle Client<br/>[Beagle.js]"]
  node_beagle_config["Beagle Config<br/>[config.js]"]
  node_beagle_service["Beagle Service"]
end

subgraph group_django["Django Jobs API"]
  node_job_api["Jobs API<br/>[views.py]"]
  node_job_serializer["Job Serializer<br/>[serializers.py]"]
  node_job_model[("Job Records<br/>[models.py]")]
  node_api_routes["API Routes<br/>[urls.py]"]
end

subgraph group_visuals["Dashboard Components"]
  node_pie_chart["Pie Chart<br/>[PieChart.js]"]
  node_error_rate["Error Rate<br/>[ErrorRate.js]"]
  node_scroll_list["Scroll List<br/>[ScrollList.js]"]
  node_loader["Progress Loader"]
end

node_operator(("Operator"))

node_operator -->|"opens dashboard"| node_app
node_app -->|"renders"| node_navigation
node_app -->|"guards routes"| node_protected
node_app -->|"routes to"| node_home
node_app -->|"routes to"| node_runs
node_app -->|"routes to"| node_files
node_app -->|"routes to"| node_login
node_protected -->|"redirects to"| node_login
node_login -->|"authenticates via"| node_beagle_client
node_login -->|"uses session keys"| node_beagle_config
node_home -->|"fetches summaries"| node_beagle_client
node_home -->|"renders charts"| node_pie_chart
node_home -->|"renders error rates"| node_error_rate
node_home -->|"renders long runs"| node_scroll_list
node_runs -->|"fetches runs"| node_beagle_client
node_runs -->|"uses run definitions"| node_beagle_config
node_runs -->|"shows loading state"| node_loader
node_files -->|"fetches file counts"| node_beagle_client
node_files -->|"shows loading state"| node_loader
node_beagle_client -->|"uses service settings"| node_beagle_config
node_beagle_client -->|"sends API requests"| node_beagle_service
node_api_routes -->|"routes requests"| node_job_api
node_job_api -->|"serializes records"| node_job_serializer
node_job_api -->|"queries records"| node_job_model
node_job_serializer -->|"serializes model"| node_job_model

click node_app "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/App.js"
click node_navigation "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/navigation/Navigation.js"
click node_protected "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/Protected.js"
click node_login "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/login/Login.js"
click node_home "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/home/Home.js"
click node_runs "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/runs/Runs.js"
click node_files "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/files/Files.js"
click node_beagle_client "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/Beagle.js"
click node_beagle_config "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/config.js"
click node_pie_chart "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/charts/PieChart.js"
click node_error_rate "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/home/ErrorRate.js"
click node_scroll_list "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/lists/ScrollList.js"
click node_loader "https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/loaders/LinearIndeterminate.js"
click node_job_api "https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/jobsdb/views.py"
click node_job_serializer "https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/jobsdb/serializers.py"
click node_job_model "https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/jobsdb/models.py"
click node_api_routes "https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/voyager_server/urls.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_navigation,node_protected,node_login,node_home,node_runs,node_files toneBlue
class node_beagle_client,node_beagle_config,node_beagle_service toneAmber
class node_job_api,node_job_serializer,node_job_model,node_api_routes toneMint
class node_pie_chart,node_error_rate,node_scroll_list,node_loader toneRose
class node_operator toneIndigo
```

## Components

### Dashboard UI

- [App Routing](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/App.js): `voyager-operation-dashboard/src/App.js`
- [Navigation](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/navigation/Navigation.js): `voyager-operation-dashboard/src/pages/navigation/Navigation.js`
- [Route Guard](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/Protected.js): `voyager-operation-dashboard/src/components/common/Protected.js`
- [Login](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/login/Login.js): `voyager-operation-dashboard/src/pages/login/Login.js`
- [Home Dashboard](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/home/Home.js): `voyager-operation-dashboard/src/pages/home/Home.js`
- [Runs Browser](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/runs/Runs.js): `voyager-operation-dashboard/src/pages/runs/Runs.js`
- [Files View](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/files/Files.js): `voyager-operation-dashboard/src/pages/files/Files.js`

### Beagle Integration

- [Beagle Client](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/Beagle.js): `voyager-operation-dashboard/src/components/common/Beagle.js`
- [Beagle Config](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/common/config.js): `voyager-operation-dashboard/src/components/common/config.js`
- **Beagle Service**

### Django Jobs API

- [Jobs API](https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/jobsdb/views.py): `server/voyager_server/jobsdb/views.py`
- [Job Serializer](https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/jobsdb/serializers.py): `server/voyager_server/jobsdb/serializers.py`
- [Job Records](https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/jobsdb/models.py): `server/voyager_server/jobsdb/models.py`
- [API Routes](https://github.com/mskcc/voyager-operation-dashboard/blob/main/server/voyager_server/voyager_server/urls.py): `server/voyager_server/voyager_server/urls.py`

### Dashboard Components

- [Pie Chart](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/charts/PieChart.js): `voyager-operation-dashboard/src/components/charts/PieChart.js`
- [Error Rate](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/pages/home/ErrorRate.js): `voyager-operation-dashboard/src/pages/home/ErrorRate.js`
- [Scroll List](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/lists/ScrollList.js): `voyager-operation-dashboard/src/components/lists/ScrollList.js`
- [Progress Loader](https://github.com/mskcc/voyager-operation-dashboard/blob/main/voyager-operation-dashboard/src/components/loaders/LinearIndeterminate.js): `voyager-operation-dashboard/src/components/loaders/LinearIndeterminate.js`

### Other components

- **Operator**

## Connections

- Operator → App Routing: opens dashboard
- App Routing → Navigation: renders (evidence: `voyager-operation-dashboard/src/App.js`)
- App Routing → Route Guard: guards routes (evidence: `voyager-operation-dashboard/src/App.js`)
- App Routing → Home Dashboard: routes to (evidence: `voyager-operation-dashboard/src/App.js`)
- App Routing → Runs Browser: routes to (evidence: `voyager-operation-dashboard/src/App.js`)
- App Routing → Files View: routes to (evidence: `voyager-operation-dashboard/src/App.js`)
- App Routing → Login: routes to (evidence: `voyager-operation-dashboard/src/App.js`)
- Route Guard → Login: redirects to (evidence: `voyager-operation-dashboard/src/components/common/Protected.js`)
- Login → Beagle Client: authenticates via (evidence: `voyager-operation-dashboard/src/pages/login/Login.js`)
- Login → Beagle Config: uses session keys (evidence: `voyager-operation-dashboard/src/pages/login/Login.js`)
- Home Dashboard → Beagle Client: fetches summaries (evidence: `voyager-operation-dashboard/src/pages/home/Home.js`)
- Home Dashboard → Pie Chart: renders charts (evidence: `voyager-operation-dashboard/src/pages/home/Home.js`)
- Home Dashboard → Error Rate: renders error rates (evidence: `voyager-operation-dashboard/src/pages/home/Home.js`)
- Home Dashboard → Scroll List: renders long runs (evidence: `voyager-operation-dashboard/src/pages/home/Home.js`)
- Runs Browser → Beagle Client: fetches runs (evidence: `voyager-operation-dashboard/src/pages/runs/Runs.js`)
- Runs Browser → Beagle Config: uses run definitions (evidence: `voyager-operation-dashboard/src/pages/runs/Runs.js`)
- Runs Browser → Progress Loader: shows loading state (evidence: `voyager-operation-dashboard/src/pages/runs/Runs.js`)
- Files View → Beagle Client: fetches file counts (evidence: `voyager-operation-dashboard/src/pages/files/Files.js`)
- Files View → Progress Loader: shows loading state (evidence: `voyager-operation-dashboard/src/pages/files/Files.js`)
- Beagle Client → Beagle Config: uses service settings (evidence: `voyager-operation-dashboard/src/components/common/Beagle.js`)
- Beagle Client → Beagle Service: sends API requests (evidence: `voyager-operation-dashboard/src/components/common/Beagle.js`)
- API Routes → Jobs API: routes requests (evidence: `server/voyager_server/voyager_server/urls.py`)
- Jobs API → Job Serializer: serializes records (evidence: `server/voyager_server/jobsdb/views.py`)
- Jobs API → Job Records: queries records (evidence: `server/voyager_server/jobsdb/views.py`)
- Job Serializer → Job Records: serializes model (evidence: `server/voyager_server/jobsdb/serializers.py`)
