BunshipBunship

Quick Start

Get Bunship running locally with app, admin, and docs in one deployment model.

Prerequisites

Install Bun

Bunship uses Bun workspaces for dependency and script management.

bun --version

Prepare base services

Recommended local services:

  • PostgreSQL
  • Redis
  • (Optional) Stripe test account

Install Git

git --version

Quick Installation

Get source code

git clone <your-repo-url> bunship
cd bunship

Download ZIP, extract it, and open the project root in your terminal.

Install dependencies

bun install
pnpm install

Configure environment variables

cp .env.example .env

Minimum required variables:

  • DATABASE_URL
  • BETTER_AUTH_SECRET
  • SITE_URL

.env.example is the local/Web/API runtime template, not the Docker build variable list. The minimal Docker build inputs are documented in the deployment guide.

Initialize database

bun run db:generate
bun run db:deploy

Start development server

bun run dev

Default URLs:

  • http://localhost:3001/en
  • http://localhost:3001/en/admin
  • http://localhost:3001/en/docs

Tip

For the fastest validation, run this flow first: signup -> wallet -> subscription -> AI generation -> admin check.

Next Steps