Building from Source

How to clone, build, and run OpenWaggle from source.

Prerequisites

• Node.js 24.x — nodejs.org
• pnpm 10+ — pnpm.io

Clone and Install

git clone https://github.com/OpenWaggle/OpenWaggle.git
cd OpenWaggle
pnpm install

Development Mode

pnpm dev

This launches the Electron app with hot-reload for the UI. Changes to the backend require restarting the app.

Production Build

pnpm build

Platform Installers

pnpm build:mac    # macOS .dmg (x64 + arm64)
pnpm build:win    # Windows NSIS installer (x64)
pnpm build:linux  # Linux AppImage (x64)