eigen/trackgo-fe
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

feat: enhance architecture diagrams in README for core-api and core-i18n with improved styling and clarity

Browse Source
This commit is contained in:
Firman Ramdhani
2026-05-29 16:29:46 +07:00
parent d3eb242ebe
commit ab0625d393
2 changed files with 64 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/core-api/README.md
+37 -25
View File
@@ -9,13 +9,20 @@ The platform-agnostic API engine for the monorepo. Provides an isolated HTTP cli
--- ---
## Architecture Overview ## Architecture Overview
```mermaid ```mermaid
graph TD graph TD
%% ─── Styling Definitions (Dark-Mode Friendly Enterprise Palette) ───
classDef appEntity fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e3a8a
classDef coreEngine fill:#6366f1,stroke:#4338ca,stroke-width:2px,color:#ffffff
classDef dataService fill:#10b981,stroke:#047857,stroke-width:2px,color:#ffffff
classDef observability fill:#f59e0b,stroke:#b45309,stroke-width:2px,color:#ffffff
classDef errorNode fill:#f43f5e,stroke:#be123c,stroke-width:2px,color:#ffffff
%% ─── Subgraphs ───
subgraph Apps ["apps/* (App Autonomy)"] subgraph Apps ["apps/* (App Autonomy)"]
WEB[apps/web] WEB([apps/web])
LAND[apps/landing] LAND([apps/landing])
DESK[apps/desktop] DESK([apps/desktop])
end end
subgraph Core ["@repo/core-api (Engine)"] subgraph Core ["@repo/core-api (Engine)"]
@@ -34,28 +41,31 @@ graph TD
end end
end end
WEB & LAND & DESK -->|instantiates| FACTORY %% ─── Flow & Relationships ───
WEB & LAND & DESK -->|extends| COMMON WEB & LAND & DESK ===>|instantiates| FACTORY
COMMON -->|executes via| FACTORY WEB & LAND & DESK ===>|extends| COMMON
COMMON --->|executes via| FACTORY
FACTORY -.->|reports via| FARO FACTORY -.->|reports via| FARO
FACTORY -.->|throws| API_ERR FACTORY -.->|throws| API_ERR
%% Styling Subgraphs (Backgrounds) %% ─── Apply Styles ───
style Apps fill:#e7f5ff,stroke:#74c0fc,stroke-width:2px,color:#1864ab class WEB,LAND,DESK appEntity;
style Core fill:#f8f9fa,stroke:#ced4da,stroke-width:2px,color:#495057 class FACTORY coreEngine;
class BASE,COMMON dataService;
class FARO observability;
class API_ERR errorNode;
%% Styling Nodes (Apps - Blue) %% ─── Subgraph Backgrounds (Transparent for Native GitHub Support) ───
style WEB fill:#339af0,stroke:#1864ab,color:#fff style Apps fill:transparent,stroke:#3b82f6,stroke-width:2px,stroke-dasharray: 5 5
style LAND fill:#339af0,stroke:#1864ab,color:#fff style Core fill:transparent,stroke:#94a3b8,stroke-width:2px,stroke-dasharray: 5 5
style DESK fill:#339af0,stroke:#1864ab,color:#fff
%% Styling Nodes (Core Modules) %% Nested subgraphs also need transparent backgrounds to prevent glaring white boxes in dark mode
style FACTORY fill:#845ef7,stroke:#5f3dc4,color:#fff style HTTP fill:transparent,stroke:#cbd5e1,stroke-width:1px,stroke-dasharray: 5 5
style FARO fill:#fd7e14,stroke:#d9480f,color:#fff style OBS fill:transparent,stroke:#cbd5e1,stroke-width:1px,stroke-dasharray: 5 5
style BASE fill:#20c997,stroke:#089981,color:#fff style DATA fill:transparent,stroke:#cbd5e1,stroke-width:1px,stroke-dasharray: 5 5
style COMMON fill:#20c997,stroke:#089981,color:#fff style ERRORS fill:transparent,stroke:#cbd5e1,stroke-width:1px,stroke-dasharray: 5 5
style API_ERR fill:#fa5252,stroke:#c92a2a,color:#fff ```
```
### Data Flow Lifecycle ### Data Flow Lifecycle
@@ -65,24 +75,26 @@ Every HTTP request flows through this precise interceptor pipeline:
sequenceDiagram sequenceDiagram
autonumber autonumber
box #e7f5ff App Layer (Consumers) %% ─── Dark-Mode Friendly RGBA Boxes ───
box rgba(59, 130, 246, 0.1) App Layer (Consumers)
participant C as UI Component participant C as UI Component
end end
box #f8f9fa Core Engine (@repo/core-api) box rgba(148, 163, 184, 0.1) Core Engine (@repo/core-api)
participant S as Data Service participant S as Data Service
participant H as HTTP Client participant H as HTTP Client
participant F as Faro Adapter participant F as Faro Adapter
end end
box #e7f5ff App Logic (IoC) box rgba(16, 185, 129, 0.1) App Logic (IoC)
participant A as App Hooks participant A as App Hooks
end end
box #fff5f5 External box rgba(245, 158, 11, 0.1) External
participant N as Network participant N as Network
end end
%% ─── Execution Flow ───
C->>S: getMany() C->>S: getMany()
S->>H: request() S->>H: request()
H->>F: onRequestStart() (Log + Span) H->>F: onRequestStart() (Log + Span)
packages/core-i18n/README.md
+26 -25
View File
@@ -16,49 +16,50 @@ This architecture strictly adheres to **Inversion of Control (IoC)**. The core e
```mermaid ```mermaid
graph TD graph TD
%% ─── Styling Definitions (Dark-Mode Friendly Enterprise Palette) ───
classDef appEntity fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e3a8a
classDef coreEngine fill:#6366f1,stroke:#4338ca,stroke-width:2px,color:#ffffff
classDef dataStore fill:#10b981,stroke:#047857,stroke-width:2px,color:#ffffff
classDef externalAPI fill:#f59e0b,stroke:#b45309,stroke-width:2px,color:#ffffff
%% ─── Subgraphs ───
subgraph Apps ["apps/* (App Autonomy)"] subgraph Apps ["apps/* (App Autonomy)"]
UI[React Components] UI([React Components])
DICT[Feature Dictionaries<br/>e.g., booking.json] DICT[[Feature Dictionaries: booking.json]]
end end
subgraph Core ["@repo/core-i18n (Engine)"] subgraph Core ["@repo/core-i18n (Engine)"]
I18N((i18next Instance)) I18N[i18next Instance]
STORE[(core-storage)] STORE[(core-storage)]
COMMON[Common Vocabulary] COMMON[Common Vocabulary]
end end
subgraph Backend ["Backend API (External)"] subgraph Backend ["Backend API (External)"]
SYNC[Language Sync Endpoint] SYNC([Language Sync Endpoint])
TENANT[Tenant Config Endpoint] TENANT([Tenant Config Endpoint])
end end
UI -->|uses useTranslation| I18N %% ─── Flow & Relationships ───
UI ===>|uses useTranslation| I18N
DICT -.->|lazy loads| I18N DICT -.->|lazy loads| I18N
COMMON -->|preloads| I18N COMMON --->|preloads| I18N
I18N <-->|reads/persists| STORE I18N <===>|reads / persists| STORE
I18N -->|changeLanguage sync| SYNC I18N --->|changeLanguage sync| SYNC
SYNC -.->|fails? rollback| I18N SYNC -.->|fails? rollback| I18N
TENANT -.->|applyTenantOverrides| I18N TENANT -.->|applyTenantOverrides| I18N
%% Styling Subgraphs (Backgrounds) %% ─── Apply Styles ───
style Apps fill:#e7f5ff,stroke:#74c0fc,stroke-width:2px,color:#1864ab class UI,DICT appEntity;
style Core fill:#f8f9fa,stroke:#ced4da,stroke-width:2px,color:#495057 class I18N coreEngine;
style Backend fill:#fff4e6,stroke:#ffd8a8,stroke-width:2px,color:#d9480f class STORE,COMMON dataStore;
class SYNC,TENANT externalAPI;
%% Styling App Nodes (Blue) %% ─── Subgraph Backgrounds (Transparent for Native GitHub Support) ───
style UI fill:#339af0,stroke:#1864ab,color:#fff style Apps fill:transparent,stroke:#3b82f6,stroke-width:2px,stroke-dasharray: 5 5
style DICT fill:#339af0,stroke:#1864ab,color:#fff style Core fill:transparent,stroke:#94a3b8,stroke-width:2px,stroke-dasharray: 5 5
style Backend fill:transparent,stroke:#f59e0b,stroke-width:2px,stroke-dasharray: 5 5
%% Styling Core Nodes (Purple Engine, Green Storage/Data)
style I18N fill:#845ef7,stroke:#5f3dc4,color:#fff
style STORE fill:#20c997,stroke:#089981,color:#fff
style COMMON fill:#20c997,stroke:#089981,color:#fff
%% Styling Backend Nodes (Orange/Network)
style SYNC fill:#fd7e14,stroke:#d9480f,color:#fff
style TENANT fill:#fd7e14,stroke:#d9480f,color:#fff
``` ```
--- ---