SuperAPI AI 工具集

convex-quickstart

编程与开发

查看项目

更新于 10-15 21:51

技能介绍

用途:帮助从零搭建可上线的 Convex 后端,包括初始化、创建 schema、配置认证并编写首个 CRUD 操作。适用场景包括全新项目、为现有 React/Next.js 应用接入 Convex、用实时数据原型开发新功能、从其他后端迁移,以及初次教学。

前置要求:node --version 需 v18 或更高,npm --version 需 v8 或更高。

主要流程:先执行 npm install convex 安装,再运行 npx convex dev 初始化,它会创建 convex/ 目录、设置认证、启动开发服务器并生成 TypeScript 类型。随后在 convex/schema.ts 中用 defineSchema 与 defineTable 定义表及索引。认证示例采用 WorkOS AuthKit,React/Vite 使用 @workos-inc/authkit-react,Next.js 使用 @workos-inc/authkit-nextjs,并需配置相应的环境变量。之后创建 convex/lib/auth.ts 的 getCurrentUser 辅助函数和 convex/users.ts 的 store mutation,再实现 tasks 表的 list、get、create、update、remove 操作,并在前端用 useQuery、useMutation 调用 api.tasks.*。

常见模式还提供分页查询、按状态过滤与定时清理任务。项目模板覆盖 React + Vite、Next.js 和 Expo。

限制与提醒:开发期间必须使用 npx convex dev,仅在部署生产时使用 npx convex deploy。文档也列出未认证、类型未更新与慢查询的排查建议。具体功能、收费与价格等资料暂未提供。