Skip to main content

Quick Start

Get the LightningAddon extension stack running in minutes while keeping modular package boundaries.

Prerequisites

  • Node.js 20+
  • pnpm
  • Chrome or Firefox for testing

Steps

1. Install dependencies

pnpm install

2. Configure environment files

Start from envs/.env.example and create only the runtime files you need. All env files live in the root envs/ directory.

  • Extension apps: envs/.env.development (local dev) and envs/.env.production (production build)
  • Supabase backend: envs/.env.supabase.local
  • Firebase backend: envs/.env.firebase.local

See Environment Setup for the full list of required keys.

3. Choose your backend

Pick one backend for auth and server flows:

BackendEnv fileApps
Supabaseenvs/.env.supabase.localapps/supabase
Firebaseenvs/.env.firebase.localapps/firebase

Detailed setup guides:

4. Run the extension locally

pnpm dev

This starts all dev servers (main, popup, in-page, background). In a separate terminal, build the extension:

pnpm build:chrome

5. Load in Chrome

  1. Open chrome://extensions
  2. Enable Developer mode (top right)
  3. Click Load unpacked
  4. Select apps/extension/dist (or the output directory from your build)

The extension is now running. Open the popup or the main dashboard to test auth and billing flows.

Build Commands

CommandOutput
pnpm build:chromeChrome/Chromium extension in apps/extension/dist
pnpm build:firefoxFirefox extension in apps/extension/dist
pnpm build:edgeMicrosoft Edge extension in apps/extension/dist
pnpm build:safariSafari package via Apple packager (macOS only)

See Command Reference for full details.

Next Steps