居美家房产中介平台 - 开发文档索引
📚 文档目录
本文件夹包含居美家平台完整重构的所有开发文档,请按顺序阅读。
核心文档
1. 项目总览
- 项目基础信息
- 核心功能清单
- UI设计主题
- 开发时间规划
- 风险提示
2. 后端开发文档
- 数据库表设计(MySQL 5.7兼容)
- 委托单、商圈、合同等新表
- JSON动态字段方案
- 索引优化建议
- RESTful API设计
- 委托单接口
- 视频管理接口
- 商圈接口
- 爬虫接口
- 电子合同接口
- 管理后台接口
📄 03-后端Service设计.md(待生成)
- Service层架构
- 业务逻辑封装
- 第三方服务集成
📄 04-中间件与权限设计.md(待生成)
- 中间件设计
- 权限验证
- 角色管理
3. 小程序前端文档
📄 05-小程序页面结构.md(待生成)
- 页面架构
- 路由设计
- Tabbar配置
📄 06-小程序组件设计.md(待生成)
- 核心组件
- 业务组件
- 通用组件
📄 07-小程序UI设计规范.md(待生成)
- 配色方案
- 字体规范
- 间距圆角
- 组件样式
📄 08-小程序状态管理.md(待生成)
- Pinia store设计
- API封装
- 工具函数
4. 后台管理文档
📄 09-后台管理功能清单.md(待生成)
- 功能模块列表
- 菜单结构
- 权限配置
📄 10-后台管理页面设计.md(待生成)
- 委托管理
- 视频管理
- 商圈管理
- 合同管理
- 系统配置
5. 第三方对接文档
- e签宝简介
- 接入准备
- 核心API
- 完整流程示例
- 费用说明
- 常见问题
- 基础信息
- 核心API(POI搜索、周边搜索)
- 小程序SDK使用
- 服务端调用示例
- 配额与限制
📄 13-爬虫实现文档.md(待生成)
- 贝壳房源解析
- 安居客房源解析
- 反爬虫处理
- 图片下载
6. API接口文档
📄 14-API接口文档.md(待生成)
- 完整接口列表
- 请求响应示例
- 错误码说明
🚀 快速开始
1. 阅读顺序建议
项目经理/技术负责人
00-项目总览
→ 01-数据库设计
→ 02-接口设计
→ 11-e签宝对接
→ 12-腾讯地图对接后端开发
00-项目总览
→ 01-数据库设计
→ 02-接口设计
→ 03-Service设计
→ 04-中间件设计
→ 11/12/13-第三方对接前端开发(小程序)
00-项目总览
→ 05-页面结构
→ 06-组件设计
→ 07-UI设计规范
→ 08-状态管理
→ 14-API接口文档前端开发(后台管理)
00-项目总览
→ 09-功能清单
→ 10-页面设计
→ 14-API接口文档2. 重要提示
⚠️ 必读文档
- 00-项目总览.md - 所有人必读
- 01-后端数据库设计.md - 后端开发必读
- 02-后端接口设计.md - 前后端对接必读
⚠️ 关键决策
- 房源类型扩展:单表+JSON动态字段
- 委托抢单:先到先得机制
- 视频存储:前期本地存储
- 商圈数据:腾讯地图API+手动录入
- 电子合同:对接e签宝
⚠️ 技术要点
- MySQL 5.7兼容处理(JSON字段用TEXT)
- JWT认证保留现有功能
- 小程序完全重写
- 后台管理二次开发
📋 开发检查清单
数据库阶段
- [ ] 阅读数据库设计文档
- [ ] 创建新表结构
- [ ] 扩展现有表字段
- [ ] 执行数据库迁移SQL
- [ ] 初始化配置数据
后端开发阶段
- [ ] 搭建Service层
- [ ] 开发委托单功能
- [ ] 开发视频上传功能
- [ ] 开发商圈管理功能
- [ ] 开发爬虫工具
- [ ] 对接e签宝
- [ ] 对接腾讯地图
- [ ] 完善接口文档
前端开发阶段
- [ ] 制定UI设计规范
- [ ] 搭建小程序项目
- [ ] 开发核心页面
- [ ] 开发核心组件
- [ ] 状态管理实现
- [ ] API封装
- [ ] 后台管理扩展
测试阶段
- [ ] 功能测试
- [ ] 接口测试
- [ ] 性能测试
- [ ] 兼容性测试
上线准备
- [ ] e签宝生产环境配置
- [ ] 腾讯地图配额检查
- [ ] 数据库优化
- [ ] 服务器配置
🔗 相关链接
官方文档
第三方服务
项目仓库
- Git仓库:[待填写]
- 测试环境:[待填写]
- 生产环境:[待填写]
📞 联系方式
技术支持
- 项目经理:[待填写]
- 后端负责人:[待填写]
- 前端负责人:[待填写]
第三方服务
- e签宝客服:400-8816-365
- 腾讯地图客服:400-888-5888
📝 文档更新记录
| 日期 | 版本 | 更新内容 | 更新人 |
|---|---|---|---|
| 2025-11-03 | v1.0 | 初始版本,创建核心文档 | AI助手 |
⚠️ 注意事项
- 数据库兼容性:所有SQL必须兼容MySQL 5.7
- 保留现有功能:JWT认证、图片上传、邮件服务等基础功能保留
- 项目名称统一:使用"居美家 JUMEIJIA"
- 主题色:橙色系 #FF7E00
- 开发模式:一次性完成(售后服务暂缓)
文档生成时间:2025年11月3日
文档版本:v1.0
项目代号:居美家JUMEIJIA全功能版