# ikrgycloud/icms architecture

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

- Interactive diagram: https://gitdiagram.com/ikrgycloud/icms
- Repository: https://github.com/ikrgycloud/icms

## Overview

ICMS is a role-differentiated university management platform. Users sign in, receive an authority-bound session, and get an office- and role-specific workspace; they then use domain modules whose mutations are checked by the shared authority engine and recorded in an append-only audit ledger. Persona portals scope student, faculty, and parent data to the signed-in user. The README documents these flows and capabilities; some domain APIs are unsampled, so their internal call relationships are not expanded here.

Main entry points: [`backend/main.py`](https://github.com/ikrgycloud/icms/blob/main/backend/main.py) (API Service), [`backend/authority.py`](https://github.com/ikrgycloud/icms/blob/main/backend/authority.py) (Authority Engine), [`frontend/src/api.ts`](https://github.com/ikrgycloud/icms/blob/main/frontend/src/api.ts) (API Client), [`frontend/src/App.tsx`](https://github.com/ikrgycloud/icms/blob/main/frontend/src/App.tsx) (Workspace Shell)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity &amp; Authority"]
  node_main["API Service<br/>[main.py]"]
  node_authority["Authority Engine<br/>[authority.py]"]
  node_matrices["Authority Matrices<br/>[matrices.py]"]
  node_identity_models["Identity Models<br/>[models.py]"]
end

subgraph group_domains["University Operations"]
  node_domain_api["Domain APIs<br/>[domain_api.py]"]
  node_admissions["Admissions<br/>[admissions_api.py]"]
  node_admissions_service["Admissions Transitions"]
  node_administration["Administration"]
  node_governance["Governance<br/>[governance_api.py]"]
  node_portal["Persona Portals<br/>[portal_api.py]"]
  node_integrations["Integrations"]
end

subgraph group_experience["Role Workspaces"]
  node_app["Workspace Shell<br/>[App.tsx]"]
  node_api_client["API Client<br/>[api.ts]"]
  node_admissions_ui["Admissions Workspace<br/>[Admissions.tsx]"]
  node_finance_ui["Finance Workspace<br/>[Finance.tsx]"]
  node_student_ui["Student Portal UI<br/>[StudentViews.tsx]"]
  node_workflow_ui["Workflow Views"]
  node_ui_kit["Workspace Components<br/>[kit.tsx]"]
  node_dialogs["Action Dialogs<br/>[dialogs.ts]"]
end

subgraph group_platform["Shared Platform"]
  node_domain_models["Academic &amp; Campus Records<br/>[domain_models.py]"]
  node_database[("Database<br/>[database.py]")]
  node_core["Shared Runtime<br/>[core.py]"]
end

node_user(("Institution User"))

node_user -->|"signs in"| node_main
node_main -->|"authorizes actions"| node_authority
node_authority -->|"uses policies"| node_matrices
node_authority -->|"evaluates authority"| node_identity_models
node_main -->|"routes requests"| node_domain_api
node_main -->|"routes requests"| node_admissions
node_main -->|"routes requests"| node_administration
node_main -->|"routes requests"| node_governance
node_main -->|"routes requests"| node_portal
node_main -->|"routes requests"| node_integrations
node_admissions -->|"transitions applications"| node_admissions_service
node_admissions_service -->|"checks capability"| node_authority
node_domain_api -->|"gates mutations"| node_authority
node_core -->|"opens sessions"| node_database
node_core -->|"decodes tokens"| node_authority
node_core -->|"writes audit records"| node_identity_models
node_database -->|"creates schema"| node_domain_models
node_database -->|"creates schema"| node_identity_models
node_app -->|"loads workspace"| node_api_client
node_app -->|"renders module"| node_admissions_ui
node_app -->|"renders approvals"| node_workflow_ui
node_admissions_ui -->|"requests admissions"| node_api_client
node_finance_ui -->|"requests finance"| node_api_client
node_student_ui -->|"loads persona data"| node_api_client
node_api_client -->|"calls API"| node_main
node_app -->|"uses components"| node_ui_kit
node_admissions_ui -->|"uses components"| node_ui_kit
node_finance_ui -->|"uses components"| node_ui_kit
node_admissions_ui -->|"uses dialogs"| node_dialogs

click node_main "https://github.com/ikrgycloud/icms/blob/main/backend/main.py"
click node_authority "https://github.com/ikrgycloud/icms/blob/main/backend/authority.py"
click node_matrices "https://github.com/ikrgycloud/icms/blob/main/backend/matrices.py"
click node_identity_models "https://github.com/ikrgycloud/icms/blob/main/backend/models.py"
click node_domain_api "https://github.com/ikrgycloud/icms/blob/main/backend/domain_api.py"
click node_admissions "https://github.com/ikrgycloud/icms/blob/main/backend/admissions_api.py"
click node_admissions_service "https://github.com/ikrgycloud/icms/blob/main/backend/admissions_service.py"
click node_administration "https://github.com/ikrgycloud/icms/blob/main/backend/administration_api.py"
click node_governance "https://github.com/ikrgycloud/icms/blob/main/backend/governance_api.py"
click node_portal "https://github.com/ikrgycloud/icms/blob/main/backend/portal_api.py"
click node_integrations "https://github.com/ikrgycloud/icms/blob/main/backend/integrations_api.py"
click node_domain_models "https://github.com/ikrgycloud/icms/blob/main/backend/domain_models.py"
click node_database "https://github.com/ikrgycloud/icms/blob/main/backend/database.py"
click node_core "https://github.com/ikrgycloud/icms/blob/main/backend/core.py"
click node_app "https://github.com/ikrgycloud/icms/blob/main/frontend/src/App.tsx"
click node_api_client "https://github.com/ikrgycloud/icms/blob/main/frontend/src/api.ts"
click node_admissions_ui "https://github.com/ikrgycloud/icms/blob/main/frontend/src/modules/Admissions.tsx"
click node_finance_ui "https://github.com/ikrgycloud/icms/blob/main/frontend/src/modules/Finance.tsx"
click node_student_ui "https://github.com/ikrgycloud/icms/blob/main/frontend/src/personas/StudentViews.tsx"
click node_workflow_ui "https://github.com/ikrgycloud/icms/blob/main/frontend/src/views/PrincipalWorkflowViews.tsx"
click node_ui_kit "https://github.com/ikrgycloud/icms/blob/main/frontend/src/modules/kit.tsx"
click node_dialogs "https://github.com/ikrgycloud/icms/blob/main/frontend/src/ui/dialogs.ts"

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_main,node_authority,node_matrices,node_identity_models,node_user toneBlue
class node_domain_api,node_admissions,node_admissions_service,node_administration,node_governance,node_portal,node_integrations toneAmber
class node_app,node_api_client,node_admissions_ui,node_finance_ui,node_student_ui,node_workflow_ui,node_ui_kit,node_dialogs toneMint
class node_domain_models,node_database,node_core toneRose
```

## Components

### Identity & Authority

- [API Service](https://github.com/ikrgycloud/icms/blob/main/backend/main.py): `backend/main.py`
- [Authority Engine](https://github.com/ikrgycloud/icms/blob/main/backend/authority.py): `backend/authority.py`
- [Authority Matrices](https://github.com/ikrgycloud/icms/blob/main/backend/matrices.py): `backend/matrices.py`
- [Identity Models](https://github.com/ikrgycloud/icms/blob/main/backend/models.py): `backend/models.py`

### University Operations

- [Domain APIs](https://github.com/ikrgycloud/icms/blob/main/backend/domain_api.py): `backend/domain_api.py`
- [Admissions](https://github.com/ikrgycloud/icms/blob/main/backend/admissions_api.py): `backend/admissions_api.py`
- [Admissions Transitions](https://github.com/ikrgycloud/icms/blob/main/backend/admissions_service.py): `backend/admissions_service.py`
- [Administration](https://github.com/ikrgycloud/icms/blob/main/backend/administration_api.py): `backend/administration_api.py`
- [Governance](https://github.com/ikrgycloud/icms/blob/main/backend/governance_api.py): `backend/governance_api.py`
- [Persona Portals](https://github.com/ikrgycloud/icms/blob/main/backend/portal_api.py): `backend/portal_api.py`
- [Integrations](https://github.com/ikrgycloud/icms/blob/main/backend/integrations_api.py): `backend/integrations_api.py`

### Role Workspaces

- [Workspace Shell](https://github.com/ikrgycloud/icms/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [API Client](https://github.com/ikrgycloud/icms/blob/main/frontend/src/api.ts): `frontend/src/api.ts`
- [Admissions Workspace](https://github.com/ikrgycloud/icms/blob/main/frontend/src/modules/Admissions.tsx): `frontend/src/modules/Admissions.tsx`
- [Finance Workspace](https://github.com/ikrgycloud/icms/blob/main/frontend/src/modules/Finance.tsx): `frontend/src/modules/Finance.tsx`
- [Student Portal UI](https://github.com/ikrgycloud/icms/blob/main/frontend/src/personas/StudentViews.tsx): `frontend/src/personas/StudentViews.tsx`
- [Workflow Views](https://github.com/ikrgycloud/icms/blob/main/frontend/src/views/PrincipalWorkflowViews.tsx): `frontend/src/views/PrincipalWorkflowViews.tsx`
- [Workspace Components](https://github.com/ikrgycloud/icms/blob/main/frontend/src/modules/kit.tsx): `frontend/src/modules/kit.tsx`
- [Action Dialogs](https://github.com/ikrgycloud/icms/blob/main/frontend/src/ui/dialogs.ts): `frontend/src/ui/dialogs.ts`

### Shared Platform

- [Academic & Campus Records](https://github.com/ikrgycloud/icms/blob/main/backend/domain_models.py): `backend/domain_models.py`
- [Database](https://github.com/ikrgycloud/icms/blob/main/backend/database.py): `backend/database.py`
- [Shared Runtime](https://github.com/ikrgycloud/icms/blob/main/backend/core.py): `backend/core.py`

### Other components

- **Institution User**

## Connections

- Institution User → API Service: signs in (evidence: `README.md`)
- API Service → Authority Engine: authorizes actions (evidence: `README.md`)
- Authority Engine → Authority Matrices: uses policies (evidence: `backend/authority.py`)
- Authority Engine → Identity Models: evaluates authority (evidence: `README.md`)
- API Service → Domain APIs: routes requests (evidence: `backend/main.py`)
- API Service → Admissions: routes requests (evidence: `backend/main.py`)
- API Service → Administration: routes requests (evidence: `backend/main.py`)
- API Service → Governance: routes requests (evidence: `backend/main.py`)
- API Service → Persona Portals: routes requests (evidence: `backend/main.py`)
- API Service → Integrations: routes requests (evidence: `backend/main.py`)
- Admissions → Admissions Transitions: transitions applications
- Admissions Transitions → Authority Engine: checks capability (evidence: `backend/admissions_service.py`)
- Domain APIs → Authority Engine: gates mutations (evidence: `README.md`)
- Shared Runtime → Database: opens sessions (evidence: `backend/core.py`)
- Shared Runtime → Authority Engine: decodes tokens (evidence: `backend/core.py`)
- Shared Runtime → Identity Models: writes audit records (evidence: `backend/core.py`)
- Database → Academic & Campus Records: creates schema (evidence: `backend/database.py`)
- Database → Identity Models: creates schema (evidence: `backend/database.py`)
- Workspace Shell → API Client: loads workspace (evidence: `frontend/src/App.tsx`)
- Workspace Shell → Admissions Workspace: renders module (evidence: `frontend/src/App.tsx`)
- Workspace Shell → Workflow Views: renders approvals (evidence: `frontend/src/App.tsx`)
- Admissions Workspace → API Client: requests admissions (evidence: `frontend/src/modules/Admissions.tsx`)
- Finance Workspace → API Client: requests finance (evidence: `frontend/src/modules/Finance.tsx`)
- Student Portal UI → API Client: loads persona data (evidence: `frontend/src/personas/StudentViews.tsx`)
- API Client → API Service: calls API (evidence: `README.md`)
- Workspace Shell → Workspace Components: uses components (evidence: `frontend/src/App.tsx`)
- Admissions Workspace → Workspace Components: uses components (evidence: `frontend/src/modules/Admissions.tsx`)
- Finance Workspace → Workspace Components: uses components (evidence: `frontend/src/modules/Finance.tsx`)
- Admissions Workspace → Action Dialogs: uses dialogs (evidence: `frontend/src/modules/Admissions.tsx`)
