docs(readme): add architecture mermaid diagram #92

wtclaude · 2026-07-22T02:13:48Z

wtclaude commented

2026-07-22 02:13:48 +00:00

Adds an Architecture section to the website README with a Mermaid diagram of the full system.

The diagram shows the real data path:

Clients — React/Vite SPA (httpOnly JWT cookie) and the native app (bearer access/refresh), plus SSO providers via OAuth+PKCE redirect.
Layered Express backend — middleware → router /api/v1 → controllers → session layer / models / SSE fan-out, the utils/ shard integration (shardIngest.js WS dispatcher + uoLinkClient.js REST client), and secretBox.js.
MariaDB (real table families) and the bot/ Discord process.
The shard bridge — ServUO dialing out over loopback TCP 127.0.0.1:7788 to the uo-link sidecar, WebSocket ingest + REST round-trips back to the backend, and the two-channel SSE fan-out (public allowlist vs. admin-sensitive).

The identical diagram is mirrored in the docs repo (docs/website/ARCHITECTURE.md + the website-README mirror) — see RunicGateway/docs PR of the same branch name. Diagram was rendered with mermaid-cli to confirm it parses.

Docs-only; no code changes.

AI-assisted: authored with Claude (Claude Code).

🤖 Generated with Claude Code

Adds an **Architecture** section to the website README with a Mermaid diagram of the full system. The diagram shows the real data path: - **Clients** — React/Vite SPA (httpOnly JWT cookie) and the native app (bearer access/refresh), plus SSO providers via OAuth+PKCE redirect. - **Layered Express backend** — `middleware → router /api/v1 → controllers → session layer / models / SSE fan-out`, the `utils/` shard integration (`shardIngest.js` WS dispatcher + `uoLinkClient.js` REST client), and `secretBox.js`. - **MariaDB** (real table families) and the `bot/` Discord process. - **The shard bridge** — ServUO dialing *out* over loopback TCP `127.0.0.1:7788` to the uo-link sidecar, WebSocket ingest + REST round-trips back to the backend, and the two-channel SSE fan-out (public allowlist vs. admin-sensitive). The identical diagram is mirrored in the docs repo (`docs/website/ARCHITECTURE.md` + the `website-README` mirror) — see RunicGateway/docs PR of the same branch name. Diagram was rendered with `mermaid-cli` to confirm it parses. Docs-only; no code changes. - [x] AI-assisted: authored with Claude (Claude Code). 🤖 Generated with [Claude Code](https://claude.com/claude-code)

wtclaude added 1 commit 2026-07-22 02:13:50 +00:00

docs(readme): add architecture mermaid diagram

PR Checks / bot-install (pull_request) Successful in 14s

Details

PR Checks / client-build (pull_request) Successful in 23s

Details

PR Checks / server-tests (pull_request) Successful in 35s

Details

c991a07c8a

Add an Architecture section with a Mermaid diagram of the full data path
(SPA/mobile clients -> layered Express backend -> MariaDB, and the uo-link
sidecar bridge to the ServUO shard) plus a Contents entry. Same diagram is
mirrored in the docs repo (docs/website/ARCHITECTURE.md).

Co-Authored-By: Claude <noreply@anthropic.com>

whitlocktech approved these changes 2026-07-22 02:14:46 +00:00

whitlocktech scheduled this pull request to auto merge when all checks succeed 2026-07-22 02:14:51 +00:00

whitlocktech merged commit 8d5bdc0d6e into main

2026-07-22 02:17:18 +00:00

whitlocktech referenced this issue from a commit

2026-07-22 02:17:19 +00:00

Merge pull request 'docs(readme): add architecture mermaid diagram' (#92) from docs/website-architecture-diagram into main

whitlocktech deleted branch docs/website-architecture-diagram

2026-07-22 02:17:20 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: RunicGateway/website#92