Coomander Docs

Getting Started

Set up your Coomander development environment and run the app locally.

Prerequisites

  • Node.js 22+
  • npm (comes with Node.js)
  • Git

Setup

1. Clone and install

git clone https://github.com/your-org/your-app.git
cd your-app/node
npm install

2. Configure environment

Copy the example env file and fill in your values:

cp .env.example .env.local

Required variables:

VariableDescriptionDefault
BETTER_AUTH_SECRETAuth session signing keynone -- run openssl rand -base64 32
BETTER_AUTH_URLYour app's public URLhttp://localhost:3013
APP_URLSame as BETTER_AUTH_URLhttp://localhost:3013
APP_NAMEDisplay name in emails/UICoomander
DATABASE_PATHSQLite database file path./data/coomander.db

3. Run database migrations

npm run db:migrate

4. Start the dev server

npm run dev

Your app is running at http://localhost:3013.

Project structure

node/
  app/              # Next.js App Router pages and API routes
  components/       # React components (admin/, landing/, ui/)
  content/          # MDX content (blog/, changelog/, docs/)
  lib/              # Shared libraries (auth, db, email, stripe)
  migrations/       # SQLite migration files
  scripts/          # CLI scripts (migrate, seed, rollback)
  public/           # Static assets

Common commands

CommandDescription
npm run devStart development server
npm run buildProduction build
npm run db:migrateRun database migrations
npm run db:generateGenerate Drizzle migrations from schema
npm run db:seedSeed database with sample data
npm testRun unit tests (Vitest)
npm run e2eRun E2E tests (Playwright)

Next steps

Coomander Documentation

Everything you need to build, deploy, and customize your Coomander application.

OAuth Setup

Configure Google and GitHub OAuth providers for your Coomander application.

On this page

PrerequisitesSetup1. Clone and install2. Configure environment3. Run database migrations4. Start the dev serverProject structureCommon commandsNext steps