主题
📦 部署和配置指南
本目录包含项目基础设施的部署和配置文档。
📋 文档清单
Supabase 后端配置
supabase-setup-guide.md - Supabase 基础设置
- 项目创建和配置
- 数据库表结构设置
- API 密钥配置
- 本地环境变量设置
- 连接测试
edge-function-deployment-guide.md - Edge Function 部署(⚠️ 真相源已迁 RB)
- 云端 API 功能部署
- lookup-or-fetch-word 函数配置
- 自动词库扩充功能
- 部署验证和测试
- 2026-06-15 起:全部 Edge Function 源码 + 部署统一归 RB 仓库 (
supabase/functions/),RVH 端仅作原理参考
🎯 快速开始
首次配置 Supabase
按照以下顺序操作:
基础配置:阅读 supabase-setup-guide.md
- 创建 Supabase 项目
- 配置数据库表
- 设置环境变量
Edge Function 部署:阅读 edge-function-deployment-guide.md
- 部署云端词汇查询函数
- 测试自动扩充功能
验证配置:运行配置检查脚本
bashbash scripts/check_api_config.sh
🔗 相关文档
- 数据库设计:../database/schema.md
- 架构设计:../design.md
- 环境变量示例:../../.env.example
- 配置检查脚本:../../scripts/check_api_config.sh
📝 维护说明
文档更新时机
何时需要更新这些文档:
- Supabase 表结构变更 → 更新 supabase-setup-guide.md
- Edge Function 新增或修改 → 在 RB 仓库改(后端真相源),RVH 仅同步说明
- API 密钥配置变更 → 更新相关指南
后端真相源(2026-06-15):共享 Supabase 后端(13 个 Edge Function + 共享表 DDL) 统一由 RB 维护:function 源
supabase/functions/,共享表 DDLsupabase/sql/sync-tables.sql。RVH 侧已不写任何 Supabase migration ——词库 pipeline 也已于 2026-07-19 迁入 RB,原来那个 supabase/migrations 死历史目录 2026-08-28 删除(内容留在 git 历史里)。迁移记录:docs/plans/archive/supabase-consolidation-plan.md。
文档归属
本目录属于 Layer 5:专项技术(7层文档体系)
- 定位:基础设施部署和配置
- 受众:DevOps、后端开发者、按需查阅
❓ 常见问题
Q: 为什么需要 Supabase? A: Supabase 提供云端词汇数据存储和 API,支持词汇回填功能(本地不存在的词汇从云端获取)。
Q: Edge Function 是必需的吗? A: 不是必需的。Edge Function 提供自动词库扩充功能,但应用可以在没有它的情况下正常运行。
Q: 如何测试配置是否正确? A: 运行 bash scripts/check_api_config.sh 进行配置检查。
最后更新:2026-01-28