Getting Started
This guide walks you through getting BunShip Pro running on your machine.
Prerequisites
| Requirement | Minimum Version | Notes |
|---|
| Bun | 1.1+ | Runtime and package manager |
| Node.js | 18+ | Used by Vite dev server for the frontend (SSR/HMR) |
The API runs on Bun natively. The frontend dev server uses Node via Vite/TanStack Start for
SSR and hot module replacement. In production builds, the output can be served by Bun.
Redis is optional — only needed for background jobs (email sending, webhook delivery).
1. Clone and Install
git clone <your-repo-url> bunship-pro
cd bunship-pro
bun install
.env and set these required values:
| Variable | What to Set |
|---|
JWT_SECRET | Any random string, 32+ characters |
JWT_REFRESH_SECRET | A different random string, 32+ characters |
ENCRYPTION_SECRET | A third random string, 32+ characters (for 2FA encryption) |
TURSO_DATABASE_URL | file:./local.db (already set — uses local SQLite) |
Set DEMO_MODE=true in .env to skip Stripe entirely. Email logs to the console when
RESEND_API_KEY is not set.
3. Set Up the Database
# Run migrations to create all tables
bun run db:migrate
# Seed demo data (creates a user, org, and sample data)
bun run db:seed
4. Start Development
This starts both the API and frontend in parallel:
To run them separately:
# API only
cd apps/api && bun run dev
# Frontend only
cd apps/web && bun run dev
5. Log In
Open http://localhost:3001 and sign in with the demo account:
Email: demo@bunship.com
Password: demo123456
What You’re Looking At
BunShip Pro has three areas:
- Marketing site — The landing page, pricing, blog, and other public pages at the root URL
- Auth pages — Login, register, forgot password, etc. at
/login, /register
- Dashboard — The authenticated app at
/dashboard, /organizations, /settings, /admin
The sidebar on the left navigates between dashboard sections. The top-right has the theme toggle and user menu.
Common Tasks
| Task | Command |
|---|
| Reset the database | bun run db:reset |
| Open Drizzle Studio (DB GUI) | bun run db:studio |
| Run API tests | cd apps/api && bun run test |
| Type-check everything | bun run typecheck |
| Build everything | bun run build |
| Lint everything | bun run lint |
| Format code | bun run format |
Next Steps
