For AI agents: fetch the complete documentation index at /llms.txt, the full documentation corpus at /llms-full.txt, the agent skill at /skill.md, or this page as Markdown at /zh/docs/web/ship-in-5-minutes.md (or send Accept: text/markdown).
5 分钟启动
使用精确的 Windows 和 macOS 命令在您的计算机上运行 Web 演示,无需付费提供商凭据,并且具有通往真实数据库支持帐户的清晰路径。
1.准备好电脑并打开项目
首先完成“开始之前”:接受 GitHub 邀请,安装 Node.js 22 或更高版本、Git、编辑器和 Corepack,然后克隆您的 Web 存储库或 All Platforms monorepo。在编辑器中打开 supastack 文件夹,然后选择 Terminal → New Terminal。您应该在编辑器的顶级文件列表中看到 package.json。下面的所有命令都从此存储库根目录运行。
这将启动本地演示,无需 AI、计费或电子邮件提供商的帐户,也无需 Docker。为首次依赖项下载留出额外的时间。在后续步骤中仅遵循 Windows 块或仅遵循 macOS/Linux 块;不要同时运行。
2. 创建配置文件——macOS/Linux
在您的终端中,运行下面的每一行。第一个副本为以后的迁移命令创建 .env。第二个创建 apps/web/.env.local,Web 服务器实际读取它。两者都包含示例的本地设置。如果任一目标文件已存在,则保留它并跳过该复制命令;不要覆盖保存的设置。 Windows 用户使用下一部分。
corepack pnpm install 下载应用程序所需的库。如果 Corepack 要求下载 pnpm,则回答 y。等待完成并返回终端提示符。如果最终消息 Done 没有错误,则意味着您可以继续。
cp .env.example .env
cp .env.example apps/web/.env.local
corepack pnpm install2、创建配置文件——Windows PowerShell
在包含 package.json 的文件夹中的 PowerShell 中使用这些命令。如果 .env 或 apps/web/.env.local 已存在,请跳过其复制行并保留您的设置。启动服务器之前等待安装完成。如果脚本执行被阻止,请使用 corepack.cmd 而不是 corepack,如开始之前中所述。
Copy-Item .env.example .env
Copy-Item .env.example apps/web/.env.local
corepack pnpm install3. 启动 Web 服务器 — 保持此终端打开
从存储库根目录运行以下命令。它仅启动 Web 应用程序,因此它可以在纯 Web 存储库和所有平台 monorepo 中运行。等待终端显示 Local: http://localhost:3000 和 Ready。第一页的编译时间可能会稍长一些。终端应保持运行;这是预期的。
在所有平台 monorepo 中,corepack pnpm dev 一起启动可用的开发工作区。如果存在 apps/docs,则该单独的文档应用程序使用 http://localhost:3001. 您正在阅读的公共指南是 http://localhost:3000/docs. 上的 Web 应用程序的一部分 您不需要端口 3001 即可遵循本教程。
corepack pnpm --filter @supastack/web dev4. 打开应用程序并完成一项本地任务
在浏览器的地址栏中,打开 http://localhost:3000 以查看主页。然后打开 http://localhost:3000/dashboard. 保留预先填写的姓名和电子邮件,或输入您自己的测试值,然后单击 Start local reference flow。这将创建一个内存中的演示工作区;它不会创建持久帐户或发送真实的电子邮件。
在演示中,从侧边栏打开 AI task,输入一个简短的请求(例如 Summarize the local Acceptance criteria),然后单击 Queue local task。当其状态为排队时,单击 Run local task,然后单击 View result。您应该看到已完成的输出和 Email queued 状态。人工智能的反应是故意伪造的且可重复的;排队的电子邮件是本地的。重新启动服务器会清除该演示数据。
要使用 /auth 进行真实注册,请首先启动 Postgres 并使用数据库和迁移指南应用迁移。此后,来自 EMAIL_PROVIDER=local 的注册或 OTP 消息可以在 http://localhost:3000/mail-preview; 上进行检查,它们不会到达外部收件箱。移动登录也使用这种数据库支持的身份验证,而不是演示会话。
5. 停止、重新启动和修复常见的首次运行问题
成功意味着主页加载、本地工作区打开并且排队任务完成。完成后,单击服务器终端并按 Ctrl + C。要稍后恢复,请在存储库根目录中重新打开终端并重复步骤 3 中的服务器命令;您不必每次都重新安装依赖项。
如果 localhost:3000 未打开,请检查服务器终端是否仍在运行并显示 Ready。如果端口 3000 正在使用,请使用 Ctrl + C 停止其他开发服务器,然后重试。如果您在打开 /auth 后看到数据库错误,请返回 /dashboard 进行演示或完成数据库指南。如果本地演示缺失,请检查apps/web/.env.local中的APP_ENV=local、AI_PROVIDER=fake、BILLING_PROVIDER=local、EMAIL_PROVIDER=local和JOB_PROVIDER=local,然后重新启动。
要自定义名称和营销文本,请在编辑器中打开 apps/web/src/marketing/site-config.ts。按照 Branding 获取确切的字段和验证步骤。对于真实账户的外观设置,请先完成数据库设置,然后打开/settings/appearance。自动接受命令比首次运行演练花费的时间更长;在工作区命令下找到它们。
如果你想继续完成设置,可以阅读《设置数据库》。