Quick Start

Prerequisites

• Node.js 20 or later
• pnpm — install via corepack enable && corepack prepare pnpm@latest --activate
• A database — local SQLite (file:local.db) is enough for development; use PostgreSQL or Turso for hosted environments

Installation

npx create-codapult my-app
cd my-app
pnpm install

This scaffolds a fresh Codapult project with all modules included.

Configuration

Copy the example environment file and fill in the required values:

cp .env.example .env.local

At minimum, set these variables for the default adapters:

TURSO_AUTH_TOKEN is also required when using Turso cloud (not needed for file:local.db). All other variables are optional and documented in .env.example.

Tip: To skip auth and payments setup, set AUTH_PROVIDER=none — only TURSO_DATABASE_URL is required. This runs Codapult in showcase/marketing mode.

If you prefer PostgreSQL

Turso is the default because local setup is fast and a SQLite file works without external services. If your team prefers PostgreSQL, switch the database provider in .env.local:

DB_PROVIDER="postgres"
DATABASE_URL="postgresql://user:password@host:5432/dbname?sslmode=require"

When DB_PROVIDER=postgres, pnpm db:* commands use the PostgreSQL Drizzle schema and connection string automatically. Keep TURSO_DATABASE_URL only if you plan to switch back to the default Turso/LibSQL provider.

Database Setup

Push the schema to your configured database — this creates all tables in one step:

pnpm db:push

Optionally seed sample data (users, organizations, plans) for local testing:

pnpm db:seed

Start the Dev Server

pnpm dev

Open http://localhost:3000. You should see the Codapult landing page. Click Sign Up to create your first account.

Interactive Setup Wizard

Run the setup wizard to choose which modules to keep. It removes unused code, routes, and database tables cleanly:

npx @codapult/cli setup

The wizard walks you through each optional module (AI chat, blog, teams, notifications, etc.) and strips out anything you don't need.

Important: The setup wizard makes permanent changes to the codebase. Removed modules are deleted — routes, components, schema tables, and imports. Re-adding a module later requires manual work from the Codapult source repository. Run the wizard before writing any custom code.

Useful Commands

Next Steps

• Project Structure — understand the directory layout and config files
• Authentication — configure sign-in methods, 2FA, and SSO
• Payments & Billing — set up subscription tiers and billing
• Customization — theming, branding, and white-label options