Installation

Prerequisites

• Node.js 20+
• pnpm 9+
• Docker Desktop (for local services)
• Git

1. Get access

Don't have TheShipStack yet? Purchase it here.

After purchase you'll receive an invitation to the private GitHub repo. Accept it, then clone:

git clone https://github.com/your-username/theshipstack.git my-app
cd my-app

2. Install dependencies

pnpm install

3. Set up environment variables

cp .env.example .env

Open .env and fill in the required values. See the Environment page for a full reference.

4. Start local services

docker compose up -d

This starts PostgreSQL, MinIO (file storage), and Mailpit (email). See Local Development for details.

5. Push the database schema

pnpm db:push

6. Start the dev server

pnpm dev

Open http://localhost:3000. The app is running.