Skip to content

Boards

v0.5.0

Collaborative infinite-canvas boards with live cursors, stored in the database

Install Boards

Admins create boards and open them as an infinite Fresco canvas with the Etcher drawing layer for shapes, text and images. Several people on one board see each other's edits, cursors and presence in real time. Each board is one row in phoenix_kit_boards with the canvas document in a jsonb column; pasted images go to PhoenixKit Storage.

Use it when

  • Your team needs a shared whiteboard inside the admin of your own app
  • You want sketches and pasted screenshots kept in your database and storage, not a third-party tool

What it gives you

  • Boards list at /admin/boards (create, open, delete)
  • Real-time shared editing with presence roster and live cursors
  • Pasted or dropped images uploaded through the Storage module
  • Pasted links turned into OpenGraph preview cards (fetched under an SSRF guard)
  • Optional dedicated socket for high-rate cursor and drag traffic

Example

From the README
socket "/phoenix_kit/board", PhoenixKitBoards.Web.BoardSocket, websocket: true

Boards news

Nothing posted about Boards yet. Read its changelog or see all PhoenixKit news.

Install

1 Add to mix.exs

deps
{:phoenix_kit_boards, "~> 0.5"}

2 Fetch it and run its migrations

Terminal
$ mix deps.get && mix phoenix_kit.update

3 Switch it on in /admin/modules

Releases
  1. 0.5.0
  2. 0.4.7
  3. 0.4.6
Admin
/admin/boards

Related modules

What it needs, what builds on it, and its neighbours in Content & community.