SparkLumina
Back to Docs

Quick Start

Get up and running with SparkLumina in minutes. Create your first collaborative whiteboard room.

2 min read

Prerequisites

Before starting, ensure you have Node.js 18+, npm 9+, and Git installed on your machine. A modern browser (Chrome, Firefox, Safari, or Edge) is required. For AI features, you will also need the Python-based AI service; we'll cover that in the Installation guide.

Clone the Repository

Clone the SparkLumina (TeachBoardOpenEDU) repository and navigate into the project root:

git clone https://github.com/your-org/TeachBoardOpenEDU.git
cd TeachBoardOpenEDU

Replace the URL with your actual repository if you're working from a fork or private clone.

Install Dependencies

From the project root, run:

npm install

This installs dependencies for the monorepo, including the frontend whiteboard app, the Next.js website, and the Node.js backend.

Configure Environment

Copy the example environment file and edit it with your settings:

cp .env.example .env

At minimum, ensure your .env includes:

  • Backend API URL (default: http://localhost:8056)
  • AI service URL (default: http://localhost:8652) if you plan to use AI features

See Configuration for full options.

Start the Dev Server

Start the frontend and backend together. The frontend runs on port 8051, and the backend on port 8056:

npm run dev

Or start them separately in different terminals:

  • Frontend: npm run dev --workspace=whiteboard (or the appropriate script)
  • Backend: npm run dev:server (or equivalent)

Open in the Browser

Open your browser and go to:

http://localhost:8051

You should see the SparkLumina whiteboard interface.

Create a Room and Invite Others

  1. Click Create Room or New Room on the welcome screen.
  2. You'll receive a room ID (e.g., a short alphanumeric string).
  3. Share the room ID or the full URL (e.g., http://localhost:8051/?room=abc123) with collaborators.
  4. Anyone with the link can join and collaborate in real time—they'll see live cursors, shared elements, and synchronized edits instantly via Socket.IO.

That's it! You're ready to draw, annotate, and collaborate. Try the AI Smart Drawing sidebar or the Board Agent for AI-powered canvas control.