SuperAPI AI 工具集

convex-quickstart

编程与开发

查看项目

更新于 10-15 20:34

技能介绍

用途:快速搭建可运行的 Convex 项目,或为已有前端应用添加 Convex 后端。

主要能力:提供两条路径。新项目用 npm create convex@latest 选择模板脚手架,模板包括 react-vite-shadcn、nextjs-shadcn、nextjs-clerk、nextjs-convexauth-shadcn、bare 等,也支持任意 GitHub 仓库作为模板;已有应用则安装 convex 并在根组件接入 ConvexProvider。

使用方式:新项目执行 npm create convex@latest my-app -- -t react-vite-shadcn,再 cd 并 npm install;已有应用执行 npm install convex。随后由用户在终端运行 npx convex dev,首次会触发浏览器登录,创建开发部署、写入 .env.local、生成 convex/ 目录并持续同步。前端另开终端运行 npm run dev。云或无头环境可设 CONVEX_AGENT_MODE=anonymous 匿名运行。开发用 npx convex dev,上线用 npx convex deploy。

适用场景:新项目原型、为现有 React/Next.js/Vue/Svelte 等应用接入后端、验证查询与变更往返。

限制:脚手架不自动执行 npm install;npx convex dev 为长驻进程且首次需交互登录,不宜由代理直接运行;项目已存在 convex/ 时无需本技能,仅加认证应改用 convex-setup-auth。