# cboard-org/cboard architecture

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

- Interactive diagram: https://gitdiagram.com/cboard-org/cboard
- Repository: https://github.com/cboard-org/cboard

## Overview

Cboard is a browser-based AAC communicator. A user opens or edits a board, searches symbol libraries, builds a message from symbols, then communicates through text-to-speech or sharing. The app also supports accounts, board access, settings, analytics, subscriptions, and offline use. The graph follows documented routes and sampled calls; several feature links are based on the README and file-tree structure because their implementation was not sampled.

Main entry points: [`src/components/App/App.component.js`](https://github.com/cboard-org/cboard/blob/master/src/components/App/App.component.js) (App routing), [`src/components/Board`](https://github.com/cboard-org/cboard/tree/master/src/components/Board) (Board experience), [`src/api/api.js`](https://github.com/cboard-org/cboard/blob/master/src/api/api.js) (Application API), [`src/components/Board/SymbolSearch/SymbolSearch.component.js`](https://github.com/cboard-org/cboard/blob/master/src/components/Board/SymbolSearch/SymbolSearch.component.js) (Symbol search)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App shell"]
  node_entry["Application entry<br/>[index.js]"]
  node_app["App routing<br/>[App.component.js]"]
  node_appstate["App state<br/>[App.reducer.js]"]
  node_account["Account access"]
end

subgraph group_boards["Boards and communication"]
  node_board["Board experience"]
  node_symbolsearch["Symbol search"]
  node_speech["Speech provider"]
  node_communicator["Communicator mode"]
end

subgraph group_services["Data and services"]
  node_symbolapi["Symbol search API<br/>[cboard-symbols.js]"]
  node_arasaacdb[("ARASAAC cache<br/>[arasaacdb.ts]")]
  node_api["Application API<br/>[api.js]"]
end

subgraph group_support["User support features"]
  node_settings["Settings"]
  node_analytics["Usage analytics"]
  node_subscriptions["Subscriptions"]
  node_gaze["Gaze switching<br/>[GazeController.js]"]
  node_access["Shared board access"]
  node_offline["Offline support"]
end

node_user(("AAC user"))
node_backend["Cboard services"]
node_browser["Browser runtime"]

node_user -->|"opens"| node_entry
node_entry -->|"renders"| node_app
node_app -->|"routes to"| node_account
node_app -->|"routes to"| node_board
node_app -->|"routes to"| node_settings
node_app -->|"routes to"| node_analytics
node_app -->|"routes to"| node_access
node_app -->|"mounts"| node_gaze
node_app -->|"reads"| node_appstate
node_board -->|"opens"| node_symbolsearch
node_symbolsearch -->|"searches"| node_symbolapi
node_symbolsearch -->|"reads"| node_arasaacdb
node_symbolsearch -->|"searches"| node_api
node_api -->|"requests"| node_backend
node_board -->|"loads boards"| node_api
node_board -->|"speaks message"| node_speech
node_board -->|"configures"| node_communicator
node_settings -->|"updates account"| node_api
node_settings -->|"manages plan"| node_subscriptions
node_subscriptions -.->|"checks plan"| node_backend
node_gaze -->|"uses camera"| node_browser
node_gaze -->|"activates selection"| node_board
node_speech -->|"generates speech"| node_browser
node_entry -->|"registers"| node_offline
node_offline -->|"caches assets"| node_browser
node_access -->|"loads shared board"| node_api
node_analytics -.->|"sends metrics"| node_backend

click node_entry "https://github.com/cboard-org/cboard/blob/master/src/index.js"
click node_app "https://github.com/cboard-org/cboard/blob/master/src/components/App/App.component.js"
click node_appstate "https://github.com/cboard-org/cboard/blob/master/src/components/App/App.reducer.js"
click node_account "https://github.com/cboard-org/cboard/tree/master/src/components/Account"
click node_board "https://github.com/cboard-org/cboard/tree/master/src/components/Board"
click node_symbolsearch "https://github.com/cboard-org/cboard/blob/master/src/components/Board/SymbolSearch/SymbolSearch.component.js"
click node_symbolapi "https://github.com/cboard-org/cboard/blob/master/src/api/cboard-symbols.js"
click node_arasaacdb "https://github.com/cboard-org/cboard/blob/master/src/idb/arasaac/arasaacdb.ts"
click node_api "https://github.com/cboard-org/cboard/blob/master/src/api/api.js"
click node_speech "https://github.com/cboard-org/cboard/tree/master/src/providers/SpeechProvider"
click node_communicator "https://github.com/cboard-org/cboard/tree/master/src/components/Communicator"
click node_settings "https://github.com/cboard-org/cboard/tree/master/src/components/Settings"
click node_analytics "https://github.com/cboard-org/cboard/tree/master/src/components/Analytics"
click node_subscriptions "https://github.com/cboard-org/cboard/tree/master/src/providers/SubscriptionProvider"
click node_gaze "https://github.com/cboard-org/cboard/blob/master/src/providers/GazeSwitchProvider/GazeController.js"
click node_access "https://github.com/cboard-org/cboard/tree/master/src/components/AccessViewer"
click node_offline "https://github.com/cboard-org/cboard/blob/master/src/registerServiceWorker.js"

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_entry,node_app,node_appstate,node_account,node_user,node_browser toneBlue
class node_board,node_symbolsearch,node_speech,node_communicator toneAmber
class node_symbolapi,node_arasaacdb,node_api toneMint
class node_settings,node_analytics,node_subscriptions,node_gaze,node_access,node_offline toneRose
class node_backend toneIndigo
```

## Components

### App shell

- [Application entry](https://github.com/cboard-org/cboard/blob/master/src/index.js): `src/index.js`
- [App routing](https://github.com/cboard-org/cboard/blob/master/src/components/App/App.component.js): `src/components/App/App.component.js`
- [App state](https://github.com/cboard-org/cboard/blob/master/src/components/App/App.reducer.js): `src/components/App/App.reducer.js`
- [Account access](https://github.com/cboard-org/cboard/tree/master/src/components/Account): `src/components/Account`

### Boards and communication

- [Board experience](https://github.com/cboard-org/cboard/tree/master/src/components/Board): `src/components/Board`
- [Symbol search](https://github.com/cboard-org/cboard/blob/master/src/components/Board/SymbolSearch/SymbolSearch.component.js): `src/components/Board/SymbolSearch/SymbolSearch.component.js`
- [Speech provider](https://github.com/cboard-org/cboard/tree/master/src/providers/SpeechProvider): `src/providers/SpeechProvider`
- [Communicator mode](https://github.com/cboard-org/cboard/tree/master/src/components/Communicator): `src/components/Communicator`

### Data and services

- [Symbol search API](https://github.com/cboard-org/cboard/blob/master/src/api/cboard-symbols.js): `src/api/cboard-symbols.js`
- [ARASAAC cache](https://github.com/cboard-org/cboard/blob/master/src/idb/arasaac/arasaacdb.ts): `src/idb/arasaac/arasaacdb.ts`
- [Application API](https://github.com/cboard-org/cboard/blob/master/src/api/api.js): `src/api/api.js`

### User support features

- [Settings](https://github.com/cboard-org/cboard/tree/master/src/components/Settings): `src/components/Settings`
- [Usage analytics](https://github.com/cboard-org/cboard/tree/master/src/components/Analytics): `src/components/Analytics`
- [Subscriptions](https://github.com/cboard-org/cboard/tree/master/src/providers/SubscriptionProvider): `src/providers/SubscriptionProvider`
- [Gaze switching](https://github.com/cboard-org/cboard/blob/master/src/providers/GazeSwitchProvider/GazeController.js): `src/providers/GazeSwitchProvider/GazeController.js`
- [Shared board access](https://github.com/cboard-org/cboard/tree/master/src/components/AccessViewer): `src/components/AccessViewer`
- [Offline support](https://github.com/cboard-org/cboard/blob/master/src/registerServiceWorker.js): `src/registerServiceWorker.js`

### Other components

- **AAC user**
- **Cboard services**
- **Browser runtime**

## Connections

- AAC user → Application entry: opens
- Application entry → App routing: renders
- App routing → Account access: routes to
- App routing → Board experience: routes to
- App routing → Settings: routes to
- App routing → Usage analytics: routes to
- App routing → Shared board access: routes to
- App routing → Gaze switching: mounts
- App routing → App state: reads
- Board experience → Symbol search: opens
- Symbol search → Symbol search API: searches
- Symbol search → ARASAAC cache: reads
- Symbol search → Application API: searches
- Application API → Cboard services: requests
- Board experience → Application API: loads boards
- Board experience → Speech provider: speaks message
- Board experience → Communicator mode: configures
- Settings → Application API: updates account
- Settings → Subscriptions: manages plan
- Subscriptions → Cboard services: checks plan
- Gaze switching → Browser runtime: uses camera
- Gaze switching → Board experience: activates selection
- Speech provider → Browser runtime: generates speech
- Application entry → Offline support: registers
- Offline support → Browser runtime: caches assets
- Shared board access → Application API: loads shared board
- Usage analytics → Cboard services: sends metrics
