whirlchat/whirl

选用指南

AI 根据 README 整理 · 2026/10/14 18:01:00

使用方式

通过命令行克隆仓库并运行开发服务器，在浏览器中访问 localhost:3000 使用。

查看 README 依据

git clone https://github.com/whirlchat/whirl.git cd whirl bun install # 1. Create a Convex dev deployment and push the backend. cd packages/backend bunx convex dev # first run walks you through creating a project # 2. In another terminal, give the backend its secrets. bunx convex env set CLERK_JWT_ISSUER_DOMAIN https://your-instance.clerk.accounts.dev bunx convex env set OPENROUTER_API_KEY sk-or-v1-... # 3. Point the web app at Convex and Clerk. cd ../../apps/v2 cp .env.example .env.local # then fill in the four required values # 4. Run everything from the repo root. cd ../..

bun run dev ``` Open [localhost:3000](http://localhost:3000) and say hi. The [self-hosting guide](docs/self-hosting.md) covers each step in detail, including the Clerk JWT template Convex needs and how to deploy to production. ## Repository layout ``` apps/ v2/ The web app (Next.js). This is the one in production. console/ Admin console for models, integrations, and skills (Vite) mobile/ Native app (Expo) waitlist/ Standalone waitlist page remotion/ Promo video compositions legacy/ The previous web app, kept for reference. Not maintained. packages/

部署要求

需要 Bun、免费的 Convex 账户、Clerk 应用和 OpenRouter API 密钥。

查看 README 依据

Everything beyond Convex, Clerk, and OpenRouter is **optional** and switches on with its own keys: billing (Autumn), web search (Exa), memory (Supermemory), analytics (PostHog, Axiom), tracing (Braintrust), email (Resend), and the support agent (Median). Leave them out and Whirl hides the features they power. See [docs/configuration.md](docs/configuration.md). ## Quick start You'll need [Bun](https://bun.sh), a free [Convex](https://convex.dev) account, a [Clerk](https://clerk.com) application, and an [OpenRouter](https://openrouter.ai) API key. ```sh

已知限制

除 Convex、Clerk 和 OpenRouter 外的功能均为可选，未配置相应密钥时相关功能会被隐藏。

查看 README 依据

Everything beyond Convex, Clerk, and OpenRouter is **optional** and switches on with its own keys: billing (Autumn), web search (Exa), memory (Supermemory), analytics (PostHog, Axiom), tracing (Braintrust), email (Resend), and the support agent (Median). Leave them out and Whirl hides the features they power. See [docs/configuration.md](docs/configuration.md). ## Quick start You'll need [Bun](https://bun.sh), a free [Convex](https://convex.dev) account, a [Clerk](https://clerk.com) application, and an [OpenRouter](https://openrouter.ai) API key. ```sh