SuperAPI AI 工具集

convex-quickstart

编程与开发

查看项目

更新于 11-02 16:14

技能介绍

Convex Quickstart 是一个用于初始化 Convex 后端的技能说明,目标是在较短时间内完成从安装到首个带认证的 CRUD 功能的搭建。

用途 它覆盖 Convex 项目初始化、数据模型定义、身份认证接入、服务端函数编写和前端调用等环节,适合新建 Convex 项目、在现有 React 或 Next.js 应用中添加 Convex、构建实时数据原型、从其他后端迁移,或用于教学演示。

主要能力 文档包含:通过 npm install convex 与 npx convex dev 完成安装与初始化;用 defineSchema、defineTable 与 v 定义表和索引的 schema 示例;使用 WorkOS AuthKit 在 React/Vite 与 Next.js 中接入认证;编写 getCurrentUser 鉴权辅助函数与用户存储 mutation;实现任务列表、单条查询、创建、更新、删除的鉴权 CRUD 示例;以及分页查询、按状态过滤和 cron 定时任务等常见模式的代码。

使用方式 先检查 Node 与 npm 版本(文档要求 Node v18+、npm v8+),安装 Convex 并运行 npx convex dev 生成 convex/ 目录与 TypeScript 类型;随后创建 schema、配置认证环境变量、编写鉴权函数与业务函数,并在前端通过 useQuery、useMutation 调用。文档强调开发阶段应使用 npx convex dev,仅在部署生产时使用 npx convex deploy。

适用场景 包括任务管理等带用户隔离的数据操作、实时列表展示、分页与筛选、定时清理等后台任务,以及 React、Next.js、Expo 模板的快速搭建。

限制 该资料仅提供示例流程和代码,具体认证配置、部署环境变量、费用、性能效果和平台支持范围暂未提供。排错部分仅列出常见提示,如“Not authenticated”、类型未更新和查询较慢,并未给出完整解决方案。