Installation

Get Underpeaks Core running locally in under five minutes.

Requirements

• Node.js 18 or higher
• npm 9 or higher
• A supported database (Supabase, MongoDB, MySQL, PostgreSQL, or Firebase)

Clone the repository

git clone https://github.com/underpeaks/underpeaks-core.git
cd underpeaks-core

Install dependencies

npm install

Start the development server

npm run dev

Open http://localhost:3000 — you should see the Underpeaks landing page.

Run the installer

Go to http://localhost:3000/installer and follow the setup wizard. This will:

1. Connect to your database
2. Create all required tables and indexes
3. Seed demo content
4. Create your admin account

See Connecting Your Database for adapter-specific setup instructions before you start the installer.

You're in

Once the installer finishes, you'll be redirected to the Underpeaks console.