BunshipBunship
Getting Started

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
  • NEXT_PUBLIC_SITE_URL
  • NEXT_PUBLIC_SERVER_URL

Initialize database

bun run db:generate
bun run db:migrate

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

Authentication

Configure OAuth and login strategies.

Wallet & Subscription

Understand credit buckets and monthly reset behavior.

Configuration

Complete production-ready environment variables.

Deployment

Follow deployment and smoke-check steps.

Architecture

Runtime topology, route boundaries, and integration boundaries.

Project Structure

Ownership boundaries and collaboration model across product domains.

On this page

Prerequisites
Install Bun
Prepare base services
Install Git
Quick Installation
Get source code
Install dependencies
Configure environment variables
Initialize database
Start development server
Next Steps