Skip to content

A realtime multiplayer whiteboard application using NATS over websockets!

Notifications You must be signed in to change notification settings

anoop-b/ivoryboard

Repository files navigation

IvoryBoard

A Whiteboard application build on top of NATS Jetstream and Nats KV.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Acknowledgments

About The Project

IvoryBoard

Instead of the usual websocket based backends, this project aims to leverage the existing feature sets make available by NATS (Message broker) which can be compared to KAFKA or Rabbit MQ which also supports persistance, message ordering and Key value storage including object storage.

Built With

  • Next

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • npm or bun or yarn
  • NATS setup (defaults to a hosted demo instance, change if required)
  • "whiteboard.nats.*" streaming subject should be setup.

Installation

  1. Install NPM packages

    npm install

    or

    bun install
  2. Run the server

    npm run dev

    or

    bun run dev
    

Usage

Enter a roomname to initiate the a whiteboard session or enter an exisiting whiteboard name to join the session.

Click on sync to begin syncing with NATS

Acknowledgments

About

A realtime multiplayer whiteboard application using NATS over websockets!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published