用途
Convex Quickstart 用于从一个一句话的应用想法出发,快速启动一个可运行的 Convex 应用。它的目标是让用户在约一分钟内看到应用在浏览器中逐步成形。
主要能力
- 根据一句话想法脚手架出一个 Next.js + shadcn 应用。
- 同时启动
convex dev与next dev,并配置错误日志监听。 - 应用运行在 bootstrap 打印的本地 URL 上,用户可实时观看构建过程。
- 提供个性化的运行手册(runbook),包含生产环境注意事项、代码模式与日志监听细节。
- 在脚手架无法运行的环境下,退化为直接编写标准 Convex 项目代码。
使用方式
- 获取想法:需要一句话描述要构建的内容;若用户未提供则询问一次。
- 脚手架:先调用
/generate获取个性化 slug,再下载 bootstrap 脚本并单独执行,轮询日志直到出现BOOTSTRAP_COMPLETE。 - 打开浏览器:脚手架完成后立即打开日志中打印的
OPEN_BROWSER_URL。 - 实时构建:先写静态 UI(使用硬编码示例数据),再通过 convex-expert 子代理编写
convex/下的后端代码,最后添加交互性;在聊天中叙述每一步。 - 自验证:运行
npx tsc --noEmit并推送到部署;修复所有错误后再声明完成。
适用场景
- 交互式会话中快速搭建可运行的应用原型。
- 用户希望实时观看应用构建过程。
- 需要标准 Convex 后端代码但无需运行脚手架的场合(退化模式)。
限制
- 本版本脚手架不含登录(auth/passkeys)、应用内面板与发布功能;仅在用户明确要求时添加认证。
- 不部署、不发布到公共 URL、不绑定自定义域名。
- 应用仅在本地运行。
- 后端代码必须放在
convex/目录下。 - 禁止对可能增长的表使用无界
.collect();应使用.withIndex(...)配合.paginate(paginationOpts)或.take(n)。 - 禁止使用
npx convex run进行验证。 - 禁止写脚手架或文档文件,除非明确要求。
- 当脚手架无法运行时(非交互会话、无网络、沙盒临时目录等),应直接编写代码而非等待脚手架。