Technical Documentation

This section covers the architecture, configuration, and API reference for Gumm. It is intended for developers and advanced users who want to self-host, configure, or extend Gumm.

Document	Description
Architecture	High-level system design and data flow
Configuration	Environment variables and runtime config keys
REST API	All HTTP endpoints with request/response examples
Module Development	How to build your own module

Development setup (without Docker)

If you want to run Gumm locally for development:

Prerequisites

Bun v1.1+ — curl -fsSL https://bun.sh/install | bash
Git

Steps

# Clone
git clone https://github.com/gumm-ai/gumm.git
cd gumm

# Install dependencies
bun install

# Create .env
cp .env.example .env
# Edit .env: set GUMM_ADMIN_PASSWORD and NUXT_SESSION_PASSWORD

# Run database migrations
bun run db:migrate

# Start dev server (hot reload)
bun run dev

Open http://localhost:3000 and follow the Setup Wizard.

Useful development commands

Command	Description
`bun run dev`	Start with hot reload
`bun run build`	Production build
`bun run preview`	Preview the production build
`bun run db:migrate`	Apply all pending migrations
`bun run db:generate`	Generate a new migration from schema changes
`bun run db:studio`	Open Drizzle Studio (database GUI)
`bun run db:seed`	Seed sample data
`bun run module:install owner/repo`	Install a module from GitHub

Technical Documentation

Contents

Development setup (without Docker)

Prerequisites

Steps

Useful development commands