CellTech/lms-frontend
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update graphs

Browse Source
This commit is contained in:
Jose Daniel G. Percy 2025-04-08 11:26:03 +08:00
parent 2b059d089a
commit 8178806075
1 changed files with 6 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/CONTRACT.md
View File

@ -148,75 +148,56 @@ The LMS user interface is designed for clarity, consistency, and ease of navigat
The following diagram illustrates a high-level flow and component relationship within the user interface: The following diagram illustrates a high-level flow and component relationship within the user interface:
```mermaid ```mermaid
flowchart TD ---
%% Layout Types (Vertical) config:
theme: neo-dark
---
flowchart LR
subgraph Layouts["Layouts"] subgraph Layouts["Layouts"]
Centered["🎯 Centered Layout (Login, Register)"] Centered["🎯 Centered Layout (Login, Register)"]
ThreeCol["🏛️ Three-Column Layout (Admin Dash)"] ThreeCol["🏛️ Three-Column Layout (Admin Dash)"]
SplitCol["| Sidebar | Content | (Split Column Layout)"] SplitCol["| Sidebar | Content | (Split Column Layout)"]
end end
%% Core Components
Header["🧭 Header (Logo, Menu, User Profile Dropdown)"] Header["🧭 Header (Logo, Menu, User Profile Dropdown)"]
Sidebar["📚 Sidebar (Optional, Collapsible)"] Sidebar["📚 Sidebar (Optional, Collapsible)"]
MainContent["🖥️ Main Content Area (Hosts Widgets/Pages)"] MainContent["🖥️ Main Content Area (Hosts Widgets/Pages)"]
Footer["📎 Footer (Links, Copyright)"] Footer["📎 Footer (Links, Copyright)"]
Modal["P M Modal Container"] Modal["P M Modal Container"]
%% Page Examples & Widget Hosting
LoginPage["🔑 Login Page"] LoginPage["🔑 Login Page"]
LoginWidget["🧩 Login Widget (SRP)"] LoginWidget["🧩 Login Widget (SRP)"]
RegisterButtonWidget["🧩 Button Widget -> Register"] RegisterButtonWidget["🧩 Button Widget -> Register"]
RegisterPage["✍️ Register Page"] RegisterPage["✍️ Register Page"]
RegisterInfoWidget["🧩 Register Info Widget"] RegisterInfoWidget["🧩 Register Info Widget"]
LoginButtonWidget["🧩 Button Widget -> Login"] LoginButtonWidget["🧩 Button Widget -> Login"]
DashboardPage["📊 Dashboard Page"] DashboardPage["📊 Dashboard Page"]
VariousWidgets["🧩 Various Dashboard Widgets"] VariousWidgets["🧩 Various Dashboard Widgets"]
ProfilePage["👤 Profile Page"] ProfilePage["👤 Profile Page"]
ProfileInfoWidget["🧩 Profile Info Widget (Pic, Name, ID, DOB)"] ProfileInfoWidget["🧩 Profile Info Widget (Pic, Name, ID, DOB)"]
PostFeedWidget["🧩 Post Feed Widget"] PostFeedWidget["🧩 Post Feed Widget"]
AdminPage["⚙️ Admin Dashboard"] AdminPage["⚙️ Admin Dashboard"]
StudentsWidget["🧩 Students Widget"] StudentsWidget["🧩 Students Widget"]
TeachersWidget["🧩 Teachers Widget"] TeachersWidget["🧩 Teachers Widget"]
ManageStudentsPage["📋 Manage Students Page"] ManageStudentsPage["📋 Manage Students Page"]
StudentTableWidget["🧩 Student Table Widget"] StudentTableWidget["🧩 Student Table Widget"]
%% Layout usage relationships (vertical chaining)
LoginPage --> Centered LoginPage --> Centered
RegisterPage --> Centered RegisterPage --> Centered
DashboardPage --> SplitCol DashboardPage --> SplitCol
ProfilePage --> SplitCol ProfilePage --> SplitCol
AdminPage --> ThreeCol AdminPage --> ThreeCol
ManageStudentsPage --> SplitCol ManageStudentsPage --> SplitCol
%% Containment relationships
LoginPage --> LoginWidget LoginPage --> LoginWidget
LoginPage --> RegisterButtonWidget LoginPage --> RegisterButtonWidget
RegisterPage --> RegisterInfoWidget RegisterPage --> RegisterInfoWidget
RegisterPage --> LoginButtonWidget RegisterPage --> LoginButtonWidget
DashboardPage --> VariousWidgets DashboardPage --> VariousWidgets
ProfilePage --> ProfileInfoWidget ProfilePage --> ProfileInfoWidget
ProfilePage --> PostFeedWidget ProfilePage --> PostFeedWidget
AdminPage --> StudentsWidget AdminPage --> StudentsWidget
AdminPage --> TeachersWidget AdminPage --> TeachersWidget
ManageStudentsPage --> StudentTableWidget ManageStudentsPage --> StudentTableWidget
%% Core Component Relationships (chained vertically)
Header --> Sidebar Header --> Sidebar
Sidebar --> MainContent Sidebar --> MainContent
MainContent --> Footer MainContent --> Footer
%% Modal Triggering (vertical flow)
UserProfile["User Profile"] --> Modal UserProfile["User Profile"] --> Modal
Modal --> AccountSettingsWidget["🧩 Account Settings Widget"] Modal --> AccountSettingsWidget["🧩 Account Settings Widget"]
MenuLinks["Menu Links"] --> Modal MenuLinks["Menu Links"] --> Modal
@ -261,7 +242,7 @@ flowchart TD
subgraph B["🐳 Docker Environment"] subgraph B["🐳 Docker Environment"]
direction TB direction TB
subgraph C["🚦 Actix Backend Container (lms-backend)"] subgraph C["🚦 Actix Backend Container (lms-backend)"]
direction LR direction TB
ActixServer["🚀 Actix HTTP Server"] --> Middleware["🛡️ Middleware (CORS, Log, Auth*)"] ActixServer["🚀 Actix HTTP Server"] --> Middleware["🛡️ Middleware (CORS, Log, Auth*)"]
Middleware --> Router["🗺️ Router (handlers.rs)"] Middleware --> Router["🗺️ Router (handlers.rs)"]
Router --> Handlers["⚙️ Route Handlers"] Router --> Handlers["⚙️ Route Handlers"]
@ -280,9 +261,6 @@ flowchart TD
end end
A --> B A --> B
%% Notes
``` ```
<!-- <!--