library-picturebook-activity/backend/docs

项目文档索引

本目录包含项目后端的所有指南和文档。

📚 文档分类

🚀 快速开始

• QUICK_START_ENV.md - 环境配置快速参考
  • 快速创建开发和生产环境配置
  • 环境区分总结表
  • 关键区别说明

🗄️ 数据库相关

• DATABASE_SETUP.md - 数据库配置指南

  • 创建数据库
  • DATABASE_URL 格式说明
  • 初始化数据库步骤
  • 验证连接方法

• DATABASE_URL_SOURCE.md - DATABASE_URL 来源说明

  • DATABASE_URL 的定义位置
  • 加载流程详解
  • 配置文件优先级
  • 验证方法

• SCHEMA_CHANGE_GUIDE.md - Prisma Schema 修改指南

  • 修改 schema.prisma 后的操作步骤
  • 生成 Prisma Client
  • 应用数据库迁移
  • 验证迁移是否成功

• ENV_CHANGE_GUIDE.md - 修改 DATABASE_URL 后的操作指南

  • 操作决策树
  • 不同场景的处理方法
  • 完整操作流程
  • 常见错误解决

⚙️ 环境配置

• ENVIRONMENT_CONFIG.md - 环境配置指南
  • 环境区分方案
  • 配置文件结构
  • 配置优先级
  • 开发/生产环境配置示例
  • 安全注意事项

🔐 权限管理

• RBAC_GUIDE.md - RBAC 权限系统指南

  • 权限系统架构
  • 权限模型说明
  • 使用示例
  • 最佳实践

• RBAC_EXAMPLES.md - RBAC 使用示例

  • 完整的权限配置示例
  • 常见场景实现
  • 代码示例

👤 账户管理

• ADMIN_ACCOUNT.md - 管理员账户指南
  • 初始化管理员账户
  • 验证管理员账户
  • 账户管理说明

📖 文档使用建议

新项目设置流程

1. 环境配置 → QUICK_START_ENV.md
2. 数据库设置 → DATABASE_SETUP.md
3. 初始化管理员 → ADMIN_ACCOUNT.md
4. 权限配置 → RBAC_GUIDE.md

日常开发流程

• 修改数据库结构 → SCHEMA_CHANGE_GUIDE.md
• 修改环境变量 → ENV_CHANGE_GUIDE.md
• 配置权限 → RBAC_EXAMPLES.md

问题排查

• 数据库连接问题 → DATABASE_URL_SOURCE.md
• 环境配置问题 → ENVIRONMENT_CONFIG.md
• 迁移问题 → SCHEMA_CHANGE_GUIDE.md

🔍 快速查找

需求	文档
如何设置开发环境？	QUICK_START_ENV.md
如何配置数据库？	DATABASE_SETUP.md
DATABASE_URL 从哪里来？	DATABASE_URL_SOURCE.md
修改 schema 后做什么？	SCHEMA_CHANGE_GUIDE.md
修改环境变量后做什么？	ENV_CHANGE_GUIDE.md
如何配置权限？	RBAC_GUIDE.md
如何创建管理员？	ADMIN_ACCOUNT.md

📝 文档更新记录

• 2024-11-19: 创建文档索引，归档所有指南文件