# arunkumarravindran/incentive-common-ui architecture

> Architecture diagram of the GitHub repository arunkumarravindran/incentive-common-ui, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/arunkumarravindran/incentive-common-ui
- Repository: https://github.com/arunkumarravindran/incentive-common-ui

## Overview

Incentive-Common-UI is a multi-tenant research-incentive and governance platform. Users enter through tenant-specific dashboard routes, then work with publication valuations, researcher scorecards, policy simulation, verification, benchmarks, and exception handling. TenantContext is the shared runtime layer: it selects tenant configuration, fetches live data, evaluates incentives, and exposes shared state to the modules. README capabilities guide coverage of modules whose source was not excerpted; connections without shown call evidence are omitted.

Main entry points: [`src/App.jsx`](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/App.jsx) (Route shell), [`src/components/ui/ChartJS.jsx`](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/components/ui/ChartJS.jsx) (Analytics charts), [`src/context/TenantContext.jsx`](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/context/TenantContext.jsx) (Tenant state), [`src/config/tenants/registry.js`](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/registry.js) (Tenant registry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_shell["Application shell"]
  node_app["Route shell<br/>[App.jsx]"]
  node_nav["Sidebar and header"]
  node_charts["Analytics charts<br/>[ChartJS.jsx]"]
end

subgraph group_workflows["Research workflows"]
  node_dashboard["Executive dashboard"]
  node_publications["Outputs workspace"]
  node_publication_drawer["Publication audit drawer"]
  node_override["Point override"]
  node_scorecards["Faculty scorecards"]
  node_faculty_drawer["Faculty details<br/>[FacultyDrawer.jsx]"]
end

subgraph group_governance["Policy governance"]
  node_exceptions["Exception queue"]
  node_policy["Policy sandbox"]
  node_verification["Verification panel"]
  node_benchmark["Institution benchmarks"]
end

subgraph group_runtime["Tenant runtime"]
  node_tenant["Tenant state<br/>[TenantContext.jsx]"]
  node_engine["Incentive engine"]
  node_registry["Tenant registry<br/>[registry.js]"]
  node_muj["MUJ policies<br/>[muj.js]"]
  node_mit["MIT-ADT policies<br/>[mit-adt.js]"]
  node_anurag["Anurag policies<br/>[anurag.js]"]
  node_api["API client<br/>[api.js]"]
end

node_user(("Institution user"))
node_backend[("Live data backend")]

node_user -->|"opens"| node_app
node_app -->|"provides tenant state"| node_tenant
node_app -->|"renders"| node_nav
node_app -->|"routes to"| node_dashboard
node_app -->|"routes to"| node_publications
node_app -->|"routes to"| node_scorecards
node_app -->|"routes to"| node_exceptions
node_app -->|"routes to"| node_policy
node_app -->|"routes to"| node_verification
node_app -->|"routes to"| node_benchmark
node_app -->|"renders"| node_publication_drawer
node_app -->|"renders"| node_faculty_drawer
node_app -->|"hosts"| node_app
node_publications -->|"opens override"| node_override
node_tenant -->|"loads tenant"| node_registry
node_tenant -->|"evaluates incentives"| node_engine
node_tenant -->|"simulates policy"| node_engine
node_tenant -->|"fetches data"| node_api
node_registry -->|"registers"| node_muj
node_registry -->|"registers"| node_mit
node_registry -->|"registers"| node_anurag
node_api -.->|"requests live data"| node_backend
node_dashboard -->|"renders analytics"| node_charts
node_publications -->|"renders analytics"| node_charts
node_scorecards -->|"renders analytics"| node_charts
node_policy -->|"renders simulation charts"| node_charts
node_verification -->|"renders analytics"| node_charts
node_benchmark -->|"renders analytics"| node_charts

click node_app "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/App.jsx"
click node_nav "https://github.com/arunkumarravindran/incentive-common-ui/tree/main/src/components/layout"
click node_tenant "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/context/TenantContext.jsx"
click node_dashboard "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/DashboardModule.jsx"
click node_publications "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/PublicationsWorkspaceModule.jsx"
click node_publication_drawer "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/PublicationDrawer.jsx"
click node_override "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/components/common/PointOverrideModal.jsx"
click node_scorecards "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/FacultyScorecardsModule.jsx"
click node_faculty_drawer "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/FacultyDrawer.jsx"
click node_exceptions "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/ExceptionQueueModule.jsx"
click node_policy "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/PolicySandboxModule.jsx"
click node_verification "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/ScorePanelModule.jsx"
click node_benchmark "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/BenchmarkModule.jsx"
click node_engine "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/engine/universalIncentiveEngine.js"
click node_registry "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/registry.js"
click node_muj "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/muj.js"
click node_mit "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/mit-adt.js"
click node_anurag "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/anurag.js"
click node_api "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/services/api.js"
click node_charts "https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/components/ui/ChartJS.jsx"

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_nav,node_charts,node_user toneBlue
class node_dashboard,node_publications,node_publication_drawer,node_override,node_scorecards,node_faculty_drawer,node_backend toneAmber
class node_exceptions,node_policy,node_verification,node_benchmark toneMint
class node_tenant,node_engine,node_registry,node_muj,node_mit,node_anurag,node_api toneRose
```

## Components

### Application shell

- [Route shell](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/App.jsx): `src/App.jsx`
- [Sidebar and header](https://github.com/arunkumarravindran/incentive-common-ui/tree/main/src/components/layout): `src/components/layout`
- [Analytics charts](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/components/ui/ChartJS.jsx): `src/components/ui/ChartJS.jsx`

### Research workflows

- [Executive dashboard](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/DashboardModule.jsx): `src/modules/DashboardModule.jsx`
- [Outputs workspace](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/PublicationsWorkspaceModule.jsx): `src/modules/PublicationsWorkspaceModule.jsx`
- [Publication audit drawer](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/PublicationDrawer.jsx): `src/modules/PublicationDrawer.jsx`
- [Point override](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/components/common/PointOverrideModal.jsx): `src/components/common/PointOverrideModal.jsx`
- [Faculty scorecards](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/FacultyScorecardsModule.jsx): `src/modules/FacultyScorecardsModule.jsx`
- [Faculty details](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/FacultyDrawer.jsx): `src/modules/FacultyDrawer.jsx`

### Policy governance

- [Exception queue](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/ExceptionQueueModule.jsx): `src/modules/ExceptionQueueModule.jsx`
- [Policy sandbox](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/PolicySandboxModule.jsx): `src/modules/PolicySandboxModule.jsx`
- [Verification panel](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/ScorePanelModule.jsx): `src/modules/ScorePanelModule.jsx`
- [Institution benchmarks](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/modules/BenchmarkModule.jsx): `src/modules/BenchmarkModule.jsx`

### Tenant runtime

- [Tenant state](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/context/TenantContext.jsx): `src/context/TenantContext.jsx`
- [Incentive engine](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/engine/universalIncentiveEngine.js): `src/engine/universalIncentiveEngine.js`
- [Tenant registry](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/registry.js): `src/config/tenants/registry.js`
- [MUJ policies](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/muj.js): `src/config/tenants/muj.js`
- [MIT-ADT policies](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/mit-adt.js): `src/config/tenants/mit-adt.js`
- [Anurag policies](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/config/tenants/anurag.js): `src/config/tenants/anurag.js`
- [API client](https://github.com/arunkumarravindran/incentive-common-ui/blob/main/src/services/api.js): `src/services/api.js`

### Other components

- **Institution user**
- **Live data backend**

## Connections

- Institution user → Route shell: opens (evidence: `src/App.jsx`)
- Route shell → Tenant state: provides tenant state (evidence: `src/App.jsx`)
- Route shell → Sidebar and header: renders (evidence: `src/App.jsx`)
- Route shell → Executive dashboard: routes to (evidence: `src/App.jsx`)
- Route shell → Outputs workspace: routes to (evidence: `src/App.jsx`)
- Route shell → Faculty scorecards: routes to (evidence: `src/App.jsx`)
- Route shell → Exception queue: routes to (evidence: `src/App.jsx`)
- Route shell → Policy sandbox: routes to (evidence: `src/App.jsx`)
- Route shell → Verification panel: routes to (evidence: `src/App.jsx`)
- Route shell → Institution benchmarks: routes to (evidence: `src/App.jsx`)
- Route shell → Publication audit drawer: renders (evidence: `src/App.jsx`)
- Route shell → Faculty details: renders (evidence: `src/App.jsx`)
- Route shell → Route shell: hosts (evidence: `src/App.jsx`)
- Outputs workspace → Point override: opens override (evidence: `src/modules/PublicationsWorkspaceModule.jsx`)
- Tenant state → Tenant registry: loads tenant (evidence: `src/context/TenantContext.jsx`)
- Tenant state → Incentive engine: evaluates incentives (evidence: `src/context/TenantContext.jsx`)
- Tenant state → Incentive engine: simulates policy (evidence: `src/context/TenantContext.jsx`)
- Tenant state → API client: fetches data (evidence: `src/context/TenantContext.jsx`)
- Tenant registry → MUJ policies: registers (evidence: `src/config/tenants/registry.js`)
- Tenant registry → MIT-ADT policies: registers (evidence: `src/config/tenants/registry.js`)
- Tenant registry → Anurag policies: registers (evidence: `src/config/tenants/registry.js`)
- API client → Live data backend: requests live data
- Executive dashboard → Analytics charts: renders analytics (evidence: `src/modules/DashboardModule.jsx`)
- Outputs workspace → Analytics charts: renders analytics (evidence: `src/modules/PublicationsWorkspaceModule.jsx`)
- Faculty scorecards → Analytics charts: renders analytics (evidence: `src/modules/FacultyScorecardsModule.jsx`)
- Policy sandbox → Analytics charts: renders simulation charts (evidence: `src/modules/PolicySandboxModule.jsx`)
- Verification panel → Analytics charts: renders analytics (evidence: `src/modules/ScorePanelModule.jsx`)
- Institution benchmarks → Analytics charts: renders analytics (evidence: `src/modules/BenchmarkModule.jsx`)
