HFU Digital Docs
BoardKit

BoardKit

Collaborative whiteboard engine with realtime sync, dual-canvas rendering, and pluggable storage for NestJS and React

BoardKit is an open-source collaborative whiteboard engine. It provides realtime collaboration, a canvas rendering engine, drawing tools, and pluggable storage. It ships as three packages that work together.

Packages

PackageDescription
@hfu.digital/boardkit-coreZero-dependency shared kernel: types, scene graph, tools, collaboration protocol
@hfu.digital/boardkit-nestjsBackend NestJS module with pluggable storage, permissions, and Socket.IO realtime gateway
@hfu.digital/boardkit-reactFrontend library with dual-canvas renderer, input pipeline, hooks, and pre-built components

Key Features

  • Realtime Collaboration — Socket.IO sync with cursor sharing, presence tracking, delta and full sync
  • 9 Drawing Tools — Pen, shape, text, sticky note, connector, select, eraser, hand (pan), laser pointer
  • Pluggable Storage — Bring your own database via abstract storage adapters (Prisma adapter included)
  • Dual-Canvas Renderer — Static layer for elements, interactive layer for cursors / previews / selections
  • LWW Conflict Resolution — Last-Writer-Wins merge strategy for concurrent edits
  • Permission Model — Role-based access control: viewer / editor / owner
  • Multi-Page Boards — Up to 100 pages per board with reordering
  • Export — PNG and SVG export with server-side rendering support
  • Session Management — Ephemeral (5-min idle) and persistent (15-min idle, snapshot on archive) sessions
  • Undo / Redo — Command-based history with configurable depth

Versioning

CalVer (yyyy.mm.version). All three packages must be pinned to the same version. See the docs root for details.

On this page