Shipkit
DocsFeaturesPricing
DocsFeaturesPricing

Command Palette

Search for a command to run...

Shipkit DocumentationBuild memory optimizationDevelopment GuideEnvironment VariablesError HandlingFile StructureMiddlewareRebranding Guide

Vercel Deployment Checks

Development GuideCLIDependency UpdatesDevToolsFeature FlagsAI PromptsSetup RequirementsSupply chaintRPCWeb Workers

FeaturesAIAnalytics IntegrationAuthenticationCMSDatabaseEmailHapticsPaymentsComponent RegistryStorageUIVisual BuilderWaitlist Feature

Quick StartDeploymentEnvironment VariablesFile StructureSetup Wizard

Caching & Rate LimitingContent ManagementError HandlingMarkdown and MDXMiddlewareProxy-Safe Server ActionsRebranding GuideWebhook Security Implementation GuideMulti-Zone ArchitectureVercel Deployment

IntegrationsPayload CMSDataFast Analytics IntegrationGoogle Analytics IntegrationGoogle Tag Manager IntegrationPostHogStatSig IntegrationUmami Analytics IntegrationAuth.js IntegrationBetter AuthClerkStack Auth IntegrationSupabase Authentication IntegrationBuilder.io IntegrationPayload CMS IntegrationAWS S3 IntegrationResend Email IntegrationUpstash Redis IntegrationVercel Blob IntegrationLemon SqueezyPolarStripe

API RoutesComponentsAPI Route SnippetsAuthentication SnippetsComponent SnippetsForm Handling SnippetsSnippets Introduction

Setup Requirements

Everything you need to get a Shipkit downstream project fully operational.

GitHub Apps

wei/pull — Upstream Sync

Automatically opens PRs when the upstream Shipkit repo is updated.

  • Install: github.com/apps/pull
  • Grant access to your fork/downstream repo
  • Config is already included at .github/pull.yml — no additional setup needed
  • Documentation

AI Coding Assistants

Claude Code

AI coding agent from Anthropic. Works with the CLAUDE.md file in the repo root for project context.

  • Install: npm install -g @anthropic-ai/claude-code
  • Auth: claude (follow the OAuth flow)
  • Usage: claude in the repo root — it reads CLAUDE.md automatically
  • Documentation

Gemini CLI

Google's AI coding assistant.

  • Install: npm install -g @google/gemini-cli
  • Auth: gemini (follow the OAuth flow)
  • Usage: gemini in the repo root — reads GEMINI.md if present
  • Documentation

OpenCode (Lash)

Terminal-based AI coding tool. Fork maintained at lacymorrow/lash.

  • Install: npm install -g @opencode-ai/opencode or use the Lash fork
  • Usage: opencode in the repo root
  • Documentation

CI / GitHub Actions

Shipkit includes workflows for:

  • Type checking — bun run typecheck
  • Linting — bun run lint
  • Build verification — bun run build

No additional setup needed — these run on push via GitHub Actions.

Environment Variables

See env.mdx for the full list. Key ones to set up first:

  • ADMIN_EMAIL — comma-separated admin emails
  • DATABASE_URL — your database connection string
  • NEXTAUTH_SECRET — generate with openssl rand -base64 32

Package Manager

Shipkit uses Bun.

# Install bun
curl -fsSL https://bun.sh/install | bash

# Install dependencies
bun install --frozen-lockfile

# Start dev server
bun dev

Recommended VS Code Extensions

  • Tailwind CSS IntelliSense
  • Prettier
  • ESLint
  • Drizzle ORM