# rodak123/canvas architecture

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

- Interactive diagram: https://gitdiagram.com/rodak123/canvas
- Repository: https://github.com/rodak123/canvas

## Overview

Canvas is a collaborative, r/place-inspired pixel canvas. A visitor opens the web client, chooses a color, and paints a cell; the client sends an action over its WebSocket connection, the server updates and persists the canvas, and connected clients receive canvas updates. The graph covers the sampled client, server, and file-backed state; palette loading is also shown. The README gives little implementation detail, so links between the client and server are limited to explicitly evidenced runtime wiring.

Main entry points: [`canvas-client/src/App.tsx`](https://github.com/rodak123/canvas/blob/main/canvas-client/src/App.tsx) (Canvas app), [`src/controllers/userController.js`](https://github.com/rodak123/canvas/blob/main/src/controllers/userController.js) (User controller), [`src/controllers/canvasController.js`](https://github.com/rodak123/canvas/blob/main/src/controllers/canvasController.js) (Canvas controller), [`src/main.js`](https://github.com/rodak123/canvas/blob/main/src/main.js) (HTTP and WS server)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Canvas client"]
  node_app["Canvas app<br/>[App.tsx]"]
  node_api["WebSocket API<br/>[ApiProvider.tsx]"]
  node_paint["Paint view<br/>[PaintCanvas.tsx]"]
  node_picker["Color picker<br/>[ColorPicker.tsx]"]
  node_loader["Connection loader<br/>[Loader.tsx]"]
  node_colors["Palette hook<br/>[useColors.ts]"]
  node_palette["Palette parser<br/>[palette.ts]"]
  node_palettefile["Palette asset<br/>[palette.txt]"]
  node_entry["Client entry<br/>[main.tsx]"]
end

subgraph group_server["Canvas server"]
  node_server["HTTP and WS server<br/>[main.js]"]
  node_socket["Socket handler<br/>[socketHandler.js]"]
  node_users["User controller<br/>[userController.js]"]
  node_canvasctl["Canvas controller"]
  node_actions["Socket actions<br/>[socketAction.js]"]
end

subgraph group_domain["Canvas domain"]
  node_canvasmodel["Canvas model<br/>[canvas.js]"]
  node_cellmodel["Cell model<br/>[cell.js]"]
end

subgraph group_state["Canvas state"]
  node_database["Canvas persistence<br/>[db.js]"]
  node_datafile[("Canvas data file<br/>[data.json]")]
end

node_visitor(("Visitor"))

node_visitor -->|"opens"| node_entry
node_entry -->|"renders"| node_app
node_entry -->|"provides context"| node_api
node_app -->|"uses"| node_api
node_app -->|"renders"| node_paint
node_app -->|"renders"| node_picker
node_app -->|"renders"| node_loader
node_picker -->|"loads colors"| node_colors
node_colors -->|"parses palette"| node_palette
node_colors -->|"fetches"| node_palettefile
node_server -->|"creates handler"| node_socket
node_server -->|"creates controller"| node_users
node_server -->|"creates controller"| node_canvasctl
node_users -->|"registers listeners"| node_socket
node_users -->|"paints and reads"| node_canvasctl
node_users -->|"uses actions"| node_actions
node_canvasctl -->|"updates"| node_canvasmodel
node_canvasctl -->|"loads and saves"| node_database
node_database -->|"serializes canvas"| node_canvasmodel
node_canvasmodel -->|"creates cells"| node_cellmodel
node_database -->|"reads and writes"| node_datafile

click node_app "https://github.com/rodak123/canvas/blob/main/canvas-client/src/App.tsx"
click node_api "https://github.com/rodak123/canvas/blob/main/canvas-client/src/services/ApiProvider.tsx"
click node_paint "https://github.com/rodak123/canvas/blob/main/canvas-client/src/components/PaintCanvas.tsx"
click node_picker "https://github.com/rodak123/canvas/blob/main/canvas-client/src/components/ColorPicker.tsx"
click node_loader "https://github.com/rodak123/canvas/blob/main/canvas-client/src/components/Loader.tsx"
click node_colors "https://github.com/rodak123/canvas/blob/main/canvas-client/src/hooks/useColors.ts"
click node_palette "https://github.com/rodak123/canvas/blob/main/canvas-client/src/utilities/palette.ts"
click node_palettefile "https://github.com/rodak123/canvas/blob/main/canvas-client/public/palette.txt"
click node_entry "https://github.com/rodak123/canvas/blob/main/canvas-client/src/main.tsx"
click node_server "https://github.com/rodak123/canvas/blob/main/src/main.js"
click node_socket "https://github.com/rodak123/canvas/blob/main/src/socket/socketHandler.js"
click node_users "https://github.com/rodak123/canvas/blob/main/src/controllers/userController.js"
click node_canvasctl "https://github.com/rodak123/canvas/blob/main/src/controllers/canvasController.js"
click node_actions "https://github.com/rodak123/canvas/blob/main/shared/socketAction.js"
click node_canvasmodel "https://github.com/rodak123/canvas/blob/main/src/models/canvas.js"
click node_cellmodel "https://github.com/rodak123/canvas/blob/main/src/models/cell.js"
click node_database "https://github.com/rodak123/canvas/blob/main/src/db.js"
click node_datafile "https://github.com/rodak123/canvas/blob/main/data.json"

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_app,node_api,node_paint,node_picker,node_loader,node_colors,node_palette,node_palettefile,node_entry toneBlue
class node_server,node_socket,node_users,node_canvasctl,node_actions toneAmber
class node_canvasmodel,node_cellmodel toneMint
class node_database,node_datafile toneRose
class node_visitor toneIndigo
```

## Components

### Canvas client

- [Canvas app](https://github.com/rodak123/canvas/blob/main/canvas-client/src/App.tsx): `canvas-client/src/App.tsx`
- [WebSocket API](https://github.com/rodak123/canvas/blob/main/canvas-client/src/services/ApiProvider.tsx): `canvas-client/src/services/ApiProvider.tsx`
- [Paint view](https://github.com/rodak123/canvas/blob/main/canvas-client/src/components/PaintCanvas.tsx): `canvas-client/src/components/PaintCanvas.tsx`
- [Color picker](https://github.com/rodak123/canvas/blob/main/canvas-client/src/components/ColorPicker.tsx): `canvas-client/src/components/ColorPicker.tsx`
- [Connection loader](https://github.com/rodak123/canvas/blob/main/canvas-client/src/components/Loader.tsx): `canvas-client/src/components/Loader.tsx`
- [Palette hook](https://github.com/rodak123/canvas/blob/main/canvas-client/src/hooks/useColors.ts): `canvas-client/src/hooks/useColors.ts`
- [Palette parser](https://github.com/rodak123/canvas/blob/main/canvas-client/src/utilities/palette.ts): `canvas-client/src/utilities/palette.ts`
- [Palette asset](https://github.com/rodak123/canvas/blob/main/canvas-client/public/palette.txt): `canvas-client/public/palette.txt`
- [Client entry](https://github.com/rodak123/canvas/blob/main/canvas-client/src/main.tsx): `canvas-client/src/main.tsx`

### Canvas server

- [HTTP and WS server](https://github.com/rodak123/canvas/blob/main/src/main.js): `src/main.js`
- [Socket handler](https://github.com/rodak123/canvas/blob/main/src/socket/socketHandler.js): `src/socket/socketHandler.js`
- [User controller](https://github.com/rodak123/canvas/blob/main/src/controllers/userController.js): `src/controllers/userController.js`
- [Canvas controller](https://github.com/rodak123/canvas/blob/main/src/controllers/canvasController.js): `src/controllers/canvasController.js`
- [Socket actions](https://github.com/rodak123/canvas/blob/main/shared/socketAction.js): `shared/socketAction.js`

### Canvas domain

- [Canvas model](https://github.com/rodak123/canvas/blob/main/src/models/canvas.js): `src/models/canvas.js`
- [Cell model](https://github.com/rodak123/canvas/blob/main/src/models/cell.js): `src/models/cell.js`

### Canvas state

- [Canvas persistence](https://github.com/rodak123/canvas/blob/main/src/db.js): `src/db.js`
- [Canvas data file](https://github.com/rodak123/canvas/blob/main/data.json): `data.json`

### Other components

- **Visitor**

## Connections

- Visitor → Client entry: opens (evidence: `canvas-client/src/main.tsx`)
- Client entry → Canvas app: renders (evidence: `canvas-client/src/main.tsx`)
- Client entry → WebSocket API: provides context (evidence: `canvas-client/src/main.tsx`)
- Canvas app → WebSocket API: uses (evidence: `canvas-client/src/App.tsx`)
- Canvas app → Paint view: renders (evidence: `canvas-client/src/App.tsx`)
- Canvas app → Color picker: renders (evidence: `canvas-client/src/App.tsx`)
- Canvas app → Connection loader: renders (evidence: `canvas-client/src/App.tsx`)
- Color picker → Palette hook: loads colors (evidence: `canvas-client/src/components/ColorPicker.tsx`)
- Palette hook → Palette parser: parses palette (evidence: `canvas-client/src/hooks/useColors.ts`)
- Palette hook → Palette asset: fetches (evidence: `canvas-client/src/hooks/useColors.ts`)
- HTTP and WS server → Socket handler: creates handler (evidence: `src/main.js`)
- HTTP and WS server → User controller: creates controller (evidence: `src/main.js`)
- HTTP and WS server → Canvas controller: creates controller (evidence: `src/main.js`)
- User controller → Socket handler: registers listeners (evidence: `src/controllers/userController.js`)
- User controller → Canvas controller: paints and reads (evidence: `src/controllers/userController.js`)
- User controller → Socket actions: uses actions (evidence: `src/controllers/userController.js`)
- Canvas controller → Canvas model: updates (evidence: `src/controllers/canvasController.js`)
- Canvas controller → Canvas persistence: loads and saves (evidence: `src/controllers/canvasController.js`)
- Canvas persistence → Canvas model: serializes canvas (evidence: `src/db.js`)
- Canvas model → Cell model: creates cells (evidence: `src/models/canvas.js`)
- Canvas persistence → Canvas data file: reads and writes (evidence: `src/db.js`)
