参考手册
查阅默认模板的配置、环境变量、资源绑定、数据库、API、类型、Reaction 和项目命令。
本章汇总 saavo-default-template 的配置和开发接口。修改配置、调用 API 或排查问题时,可以按文件名、路径或 Key 直接查找。
内容范围
本章只介绍 saavo-default-template。配置项、路由、类型、Event、Command、数据表和项目命令均以该项目源码为准。
初始化后的项目
本章的默认值取自模板源文件。通过 Saavo CLI 创建项目时,CLI 会将 package.json 的名称改为项目名、版本设为 0.0.1,并按项目名改写 Worker、D1、R2 和 Queue 的资源名称及相应普通变量。代码中的 Binding 名称保持不变,例如 DB、MAIN_R2。
选择执行本地初始化后,会安装依赖、创建 .env 并补充 SAAS_SECRET,随后生成 Binding 类型、初始化本地数据库并执行检查。初始化不会创建远程资源,也不会自动替换品牌、产品、管理员邮箱或第三方服务凭据。正式使用前仍需修改这些示例配置。
源码包会移除模板维护者使用的 commit npm script,因此初始化项目的命令集合与模板仓库略有不同。
配置与运行环境
这一部分介绍配置文件、环境变量和 Cloudflare 资源绑定。
配置文件
逐项查阅 config 目录中的配置对象和属性。
环境变量
查阅 example.vars 声明的构建变量和运行时变量。
Cloudflare 资源绑定
查阅 wrangler.jsonc 声明的 D1、KV、R2、Queue 和 Durable Object。
数据与开发接口
查阅数据表、接口、公共类型和 Reaction 定义。
数据库
查阅两个 D1 数据库的数据表、初始化脚本和数据库迁移规则。
API
查阅默认模板已注册的 API 路径、请求方法和访问要求。
类型定义
查阅请求上下文、Worker 上下文、通用结果和类型所在位置。
领域事件和命令
查阅 Reaction 已注册的 Event、Command 及其处理方式。