Installation

How to clone the repo, install dependencies, and run locally.

Prerequisites

- Node.js 20 or newer (matches the engines field in package.json) - npm (pnpm also works) - Git

Clone the repository

Clone the template with whatever directory name you want for your project:

git clone https://github.com/WhirlwindAI/whirlwind.git my-ai-startup
cd my-ai-startup

Install dependencies

npm install

Configure

The setup script prompts for each key in your terminal, writes .env.local with mode 600, and applies the database migrations. Run it yourself; it never prints a secret back. An AI agent can tell you where each key lives and verify the result, but you type the keys.

npm run setup
npm run doctor   # read-only health check

💡

Prefer doing it by hand? Copy .env.example to .env.local and fill it in. The Environment Variables guide lists every key.

Run

The landing page, blog and docs work with no keys set. Configuration turns features on; it is not a prerequisite for seeing the product.

npm run dev

💡

Open http://localhost:3000.