KaiBoard
A free, open-source, local-first multi-board whiteboard with Chinese & English handwriting fonts. Its drawing engine is built on open-source Excalidraw (MIT).
One-line pitch: No account, no cloud — your data stays on your own device. Built for personal single-user use; no real-time collaboration. On top of the drawing engine, KaiBoard adds the "multi-file / multi-board management" capability Excalidraw lacks natively, plus trash and cross-device migration. Optional Agent co-draw is available if you want it — off by default.
🙏 About the engine & credits: KaiBoard's canvas drawing abilities (pen, shapes, infinite canvas, images, frames, etc.) are 100% from open-source Excalidraw (MIT). We are grateful to the Excalidraw team and the open-source community for the high-quality drawing engine that makes "local-first multi-board whiteboard" possible. KaiBoard's additions on top — multi-board organization, local optimization, and shell capabilities — are its own. See
docs/FEATURES.md.
Design reference: The interaction paradigm for multi-board management references the general design of mature multi-board whiteboard products; the drawing engine and concrete engineering implementation are completed by KaiBoard itself.
See docs/FEATURES.md for the full feature list, docs/AGENT.md for Agent co-draw, docs/PRIVACY.md for the privacy model, and docs/SECURITY.md for the security model.
✨ Key features
- Local-first & private — data in your browser (IndexedDB) or a folder you choose (File System Access API, Chrome/Edge); no account, no upload.
- Multi-board workspace — folder-tree of boards, arbitrarily nested; drag to organize, right-click menu, trash/recovery, sidebar search.
- Import / export & migration — native
.excalidrawexchange, workspace backup with parallel-merge migration, batch import, PPTX export. - Chinese & English handwriting — built-in Xiaolai (Chinese) + Virgil (English) handwriting fonts; Simplified / Traditional Chinese / English UI; light & dark themes.
- Onboarding — first-run sample, empty-board welcome, element comments.
- Infinite canvas — inherited from Excalidraw.
- Agent co-draw (optional) — let an AI Agent draw on the board you have open: live edits, undoable, no export/import round-trip. Off by default; it talks only to a relay on
127.0.0.1, so board data never leaves your machine. Seedocs/AGENT.md.
📸 Screenshots
* All images come from KaiBoard's real running UI and real canvas exports — nothing is a mockup. Board content is co-drawn by Kai and his AI agent, Buddy.
🚀 Quick start
npm install
npm run dev
# defaults to http://localhost:5173
npm run dev auto-runs scripts/prepare-fonts.mjs before starting, generating fonts from the installed @excalidraw/excalidraw dependency (dist/prod/fonts) into public/fonts — fonts are not committed to the repo and are force-synced every time (see .gitignore).
📦 Build to a static directory
npm run build # production build, output in dist/
npm run preview # preview the build (vite preview --outDir dist)
Do not open
dist/index.htmldirectly — Excalidraw 0.18+ is ESM and loads fonts viafetch, whichfile://blocks by CORS. Use a static server:npm run preview # or npx serve dist
🛠 Tech stack
📂 Data model
IndexedDB database kaiboard:
Board content is stored in the
boardsstore by the board's own id (one-to-one with the file-tree node).
⚠️ Known issues / notes
- Collaboration disabled: the offline scenario explicitly hides collaboration UI to avoid needless network requests and console errors.
- Font size: the Chinese handwriting font is ~2.6 MB woff2, slightly slow on first load (Virgil override keeps it offline); fonts are generated at build time and not distributed with the repo.
- Image attachments: images pasted in Excalidraw are stored as base64 in
boards.files, consuming IndexedDB quota; in extreme cases clear via DevTools. - Multiple tabs: different tabs each hold a canvas instance; concurrent edits resolve to the last save.
🔄 Dependency version & upgrade strategy
KaiBoard pins @excalidraw/[email protected] (see Tech stack). On "what happens on future updates":
- No auto-follow: npm deps are pinned; unless we actively change
package.jsonand reinstall, it stays at 0.18.1 — we control upgrade timing. - Upgrades are deliberate + need evaluation: Excalidraw has breaking changes across versions (e.g.
appStatestructure,restore()signature, collaboration API). KaiBoard wraps the engine (e.g. officialrestore()to fix cross-version white-screen, bindlangCode, take overonChangeauto-save, dual-backend storage); a major upgrade needs re-regression of our shell integration. - Excalidraw's hosted advanced features (e.g. smart diagrams) are NOT in the open-source npm package: they exist only on hosted excalidraw.com / Excalidraw+. Even upgrading the npm package won't grant those — that would require KaiBoard to wire such capabilities itself.
- Recommended: keep pinned versions for stability; when a specific new capability is truly needed, scope an upgrade evaluation + regression (incl. white-screen fallback, dual-backend storage, i18n) before release.
📁 Project structure
Top-level files & directories
kaiboard/
├─ .gitignore # ignores: build output, build-time fonts, browser cache, etc.
├─ README.md # this file (English, canonical)
├─ README.zh-CN.md # Chinese version
├─ CHANGELOG.md # version history
├─ LICENSE # MIT
├─ CREDITS.md # thanks to upstream projects
├─ THIRD_PARTY_LICENSES.md # third-party license summary (Excalidraw, etc.)
├─ index.html # HTML entry; sets window.EXCALIDRAW_ASSET_PATH = "/"
├─ package.json # deps & scripts (dev / build / preview)
├─ package-lock.json # locked deps
├─ vite.config.ts # Vite config
├─ tsconfig.json # TypeScript config
├─ docs/ # public docs
│ ├─ FEATURES.md # feature details (must-read for contributors/users)
│ ├─ AGENT.md # Agent co-draw: what it is, how to connect, security boundary
│ ├─ SECURITY.md # data locations, threat model, known limitations
│ └─ PRIVACY.md # where data lives, no-upload promise, how to self-verify
├─ public/ # static assets
│ ├─ announcements.json # announcement bar text
│ └─ (fonts generated at build time by prepare-fonts.mjs from @excalidraw/excalidraw into public/fonts/; favicon inlined as data URI)
├─ scripts/ # build scripts
│ ├─ prepare-fonts.mjs # font prep (Excalidraw official + Chinese & English handwriting)
│ └─ build.mjs # production build (fonts prep + vite build)
└─ src/ # source (see next)
Core source structure
src/
├─ main.tsx # entry: import excalidraw/index.css + fonts.css + styles.css
├─ fonts.css # @font-face overrides Virgil with Chinese handwriting
├─ styles.css # app layout
├─ db.ts # IndexedDB wrapper (files / boards / settings; soft-delete & trash, settings RW)
├─ App.tsx # main component: file tree, auto-save, multi-board switch, context menu, theme, breadcrumb, save indicator
├─ Sidebar.tsx # file tree (search / inline rename / drag / empty right-click / trash entry)
├─ ContextMenu.tsx # context menu (export / duplicate / copy link / cut-copy-paste)
├─ TrashPanel.tsx # trash modal (restore / permanent delete / empty)
└─ exportImport.ts # export (workspace backup / single board .excalidraw), import (parallel merge, mandatory tree node, strip trash markers)
💬 Feedback
Questions, bug reports, and feature requests are welcome via GitHub Issues.
📄 License
- KaiBoard itself is released under the MIT License; full text in LICENSE.
- Third-party dependencies (including Excalidraw as the drawing engine) licenses in THIRD_PARTY_LICENSES.md.
- This product is built on open-source Excalidraw (MIT). It follows the MIT license and retains Excalidraw's copyright and license notices in full.
- The Chinese handwriting font (Xiaolai 小赖体, chosen/optimized by excalidraw-cn for Chinese scenarios) follows the SIL Open Font License.
- Full thanks to the upstream projects and everyone behind them: CREDITS.md.