Getting Started
Get up and running with the Board Web SDK.
New to Board? Read Concepts first to understand Pieces, Glyphs, and how Board’s touch system works.
Quick Start
Follow the Quick Start guide to add the @board.fun/web-sdk package and get a sample running on a Board.
In This Section
Quick Start
Add the @board.fun/web-sdk package to your project and confirm the bridge is reachable.
Setup Reference
ESM packaging, bundler setup, device gating, and the Board object’s API surface.
Build & Deploy
Pack your web app with web-pack and install it on a Board over Board Connect.
Upgrading the SDK
Move an existing project to a newer SDK release.
Sample
Draw the touch and Piece contacts the device reports, then deploy to a Board.
Prerequisites
- Node 18 or newer for your build toolchain
- A web project that produces a static build (for example a Vite project)
- A Board device or access to one for deployment
- The
web-packandboard-connecttools for packaging and deployment, see Build & Deploy - Basic familiarity with TypeScript and ES modules
Next Steps
Once you’re set up, explore the Guides for feature documentation that applies to every SDK.