Quick Start

Get Blank Board running in 2 minutes

Installation

1. Clone the repository

   git clone https://github.com/dheeraz101/Empty.git
   cd Empty
   
2. Start a local server

   npx serve
   

   Or simply open index.html in your browser.

3. Open the Plugin Manager

   Right-click anywhere on the board to open the Plugin Manager.

4. Browse plugins

   Switch to the Community Store tab to browse and install plugins.

Your First Plugin

Create a file at plugins/hello-world/plugin.js:

export const meta = {
  id: 'hello-world',
  name: 'Hello World',
  version: '1.0.0'
};

export function setup(api) {
  const box = document.createElement('div');
  box.className = 'plugin-box';
  box.style.cssText = `
    left: 100px;
    top: 100px;
    width: 300px;
    padding: 24px;
    background: #1a1a2e;
    color: #eee;
    border-radius: 12px;
  `;
  box.innerHTML = '<h3>Hello, World! 👋</h3><p>My first Blank Board plugin.</p>';

  api.boardEl.appendChild(box);
  api.makeDraggable(box);
}

Install it via the Plugin Manager (right-click → Install manually by URL) or add it to plugins.json:

{
  "id": "hello-world",
  "url": "./plugins/hello-world/plugin.js",
  "name": "Hello World"
}

Open browser DevTools and type window.blankBoard to access the core API for debugging.

What’s Next?

Build Your First Plugin

Full walkthrough with storage, events, and UI

Architecture Overview

Understand how the kernel works