For AI agents: the complete documentation index is available at /examples/kitchen-sink/llms.txt, the full documentation bundle is available at /examples/kitchen-sink/llms-full.txt, and this page is available as Markdown at /examples/kitchen-sink/getting-started.md.

Getting Started

Prerequisites

  • Node.js 24+
  • pnpm 10+
  • PostgreSQL 16+
  • Docker (optional, for local services)

Clone and install

git clone https://github.com/acme/platform.git
cd platform
pnpm install

Environment setup

Copy the example environment file and fill in your values:

cp .env.example .env

Required variables:

VariableDescription
DATABASE_URLPostgreSQL connection
STRIPE_SECRETStripe API secret key
JWT_SECRETToken signing secret

Start development

# Start all services
pnpm dev

# Or start individual apps
pnpm --filter web dev
pnpm --filter api dev

The web app runs on http://localhost:3000 and the API on http://localhost:4000.

Next steps