SketchPool(WIP) Docs

Overview

Sketchpool is a free, open-source networked drawing canvas. It provides realtime drawing synchronization in small rooms to build artistic community and is currently in the very early stages of development.

The following content is the MVP roadmap for this project. It should help you get an idea of the basic features that will be implemented.

Features

Websocket: Realtime Drawing Sync
PostgreSQL: API Persistence
JWT: Authorization
S3 Buckets: Canvas Snapshots
IndexedDB: Local Cache

Architecture

Single-room canvas document in memory with append-only logs. Client renders on a fixed-size canvas and scales for display.

Connections are peer-to-peer and the software can be self-hosted.

HTTP + WS Canvas

HTTP

  • POST /v1/rooms create room
  • GET /v1/room/:id fetch metadata
  • POST /v1/room/:id/export export PNG

WS

  • wss://room/:id canvas updates

Auth

JWT's in Authorization: Bearer token.

FAQ

Have a question?

Send any queries the form on my site.