Skip to content

Commit de2d557

Browse files
committed
Update README with technical details
1 parent 8922f07 commit de2d557

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,33 @@ graph TD
2121
classDef subGraphStyle fill:#1e1e1e,stroke:#333333,stroke-width:2px,color:#a3a3a3,stroke-dasharray: 5 5
2222
2323
subgraph Frontend [Frontend Next.js React]
24-
Client("Client Browser (Canvas API & React)"):::frontend
25-
State("Local State Buffer (Zustand / Refs)"):::frontend
26-
Client <-->|User Input / Renders| State
24+
Client("Client Browser <br/>(Canvas API & React)"):::frontend
25+
State("Local State Buffer <br/>(Zustand / Refs)"):::frontend
26+
Client <-->|User Input <br/>/ Renders| State
2727
end
2828
2929
subgraph Backend [Backend Infrastructure]
30-
HTTP("HTTP API Server (Express)"):::backend
31-
WS("WebSocket Server (Node.js ws)"):::backend
30+
HTTP("HTTP API Server <br/>(Node.js Express)"):::backend
31+
WS("WebSocket Server <br/>(Node.js ws)"):::backend
3232
end
3333
3434
subgraph Persistence [Persistence Layer]
35-
DB[("PostgreSQL Database (Prisma / Drizzle)")]:::storage
35+
DB[("PostgreSQL Database <br/>(Drizzle)")]:::storage
3636
end
3737
3838
%% Apply subgraph styles
3939
class Frontend,Backend,Persistence subGraphStyle
4040
4141
%% Flow connections
42-
Client -->|REST: Auth / Fetch Rooms| HTTP
42+
Client -->|REST: Auth <br/>/ Fetch Rooms| HTTP
4343
HTTP -->|Read/Write| DB
4444
45-
State <-->|Bi-directional Sync / JSON Payloads| WS
45+
State <-->|Bi-directional Sync <br/> JSON Payloads| WS
4646
WS -->|Persist Drawings/Chat| DB
4747
```
4848

4949
### Core Components
50-
- **HTTP API Server:** A RESTful Express service handling authentication, room creation, and initial metadata fetching.
50+
- **HTTP API Server:** A RESTful Node.js Express service handling authentication, room creation, and initial metadata fetching.
5151
- **WebSocket Server:** A lightweight Node `ws` server managing persistent TCP connections. It holds active rooms in memory (`Map<string, WebSocket[]>`) for O(1) routing, ensuring low-latency broadcasts of cursor movements and vector data.
5252
- **Frontend (Next.js & Canvas):** A highly optimized React application that bypasses the Virtual DOM for real-time rendering.
5353

0 commit comments

Comments
 (0)