# 仿飞书应用-23班3组

**Repository Path**: grade24-fullstack-class2/fang-feishu-app-class2-group3

## Basic Information

- **Project Name**: 仿飞书应用-23班3组
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2026-07-02
- **Last Updated**: 2026-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 飞书企业协作平台项目文档总索引

> 本目录根据 `fang-feishu-app-class2-group3/docs` 模板重新填充，内容来自 `newprd` 需求资料、后端接口调用文档和当前后端代码。
> 项目版本：v1.1.1；文档日期：2026-07-06；适用终端：Web/H5、微信小程序、Android。

---

## 一、文档体系总览

```text
feisu-template-docs/
├── README.md
├── 00-项目概览/              项目定位、范围、里程碑、团队分工
├── 01-需求分析/              PRD、功能清单、业务规则、流程、旅程、验收清单
├── 02-原型设计/              页面信息架构、核心交互、三端适配说明
├── 03-技术选型/              前后端、数据库、实时通信、部署选型
├── 04-数据库设计/            Sequelize 模型、表结构、关系和索引设计
├── 05-接口设计/              REST + Socket.IO 接口契约和调用链
├── 06-前端开发/              UniApp 三端开发规范和模块实现说明
├── 07-后端开发/              Express 后端结构、模块实现、Socket 实现
├── 08-联调测试/              测试计划、验收项、接口联调、异常场景
├── 09-部署上线/              宝塔/Nginx/Docker/反向代理/回滚方案
├── 10-运维手册/              监控、日志、备份、故障处理、上传目录维护
└── 11-周报与复盘/            分工、周报模板、复盘模板
```

---

## 二、项目核心事实

| 项目 | 内容 |
|---|---|
| 项目名称 | 飞书企业协作平台 |
| 项目定位 | 面向学习/演示场景的企业协作平台 MVP |
| 交付端 | Web/H5、微信小程序、Android |
| 前端技术 | UniApp，多端条件编译和统一接口层 |
| 后端技术 | Node.js、Express、Sequelize、MariaDB/MySQL 方言 |
| 实时通信 | Socket.IO |
| 音视频会议 | WebRTC Mesh + Socket.IO 信令 |
| 认证方式 | JWT Bearer Token |
| 文件上传 | Multer + 本地 `uploads` 目录 |
| REST Base | `https://api.syx0304.top/api/v1` |
| Socket URL | `https://api.syx0304.top` |
| 上传文件前缀 | `https://api.syx0304.top/uploads` |

---

## 三、12 阶段快速导航

| 阶段 | 目录 | 核心产出 | 当前状态 |
| :--: | :-- | :-- | :--: |
| 00 | [项目概览](00-项目概览/) | 立项书、范围、分工 | 已填充 |
| 01 | [需求分析](01-需求分析/) | PRD、功能、规则、流程、验收 | 已填充 |
| 02 | [原型设计](02-原型设计/) | 页面结构、交互、适配说明 | 已填充框架 |
| 03 | [技术选型](03-技术选型/) | 技术栈和关键方案 | 已填充 |
| 04 | [数据库设计](04-数据库设计/) | 表结构、关系、索引 | 已填充 |
| 05 | [接口设计](05-接口设计/) | REST/Socket 契约 | 已填充 |
| 06 | [前端开发](06-前端开发/) | 三端开发说明 | 已填充框架 |
| 07 | [后端开发](07-后端开发/) | 后端模块说明 | 已填充 |
| 08 | [联调测试](08-联调测试/) | 验收清单、测试计划 | 已填充 |
| 09 | [部署上线](09-部署上线/) | Nginx、Docker、回滚 | 已填充 |
| 10 | [运维手册](10-运维手册/) | 日常运维 SOP | 已填充 |
| 11 | [周报与复盘](11-周报与复盘/) | 周报和复盘模板 | 已填充 |

---

## 四、业务模块覆盖

| 模块 | REST | Socket | 三端适配重点 |
|---|---:|---:|---|
| 认证与用户 | 是 | 否 | 登录态、Token 过期、首登改密 |
| 企业与组织架构 | 是 | 否 | 组织树、角色权限 |
| 通讯录 | 是 | 否 | 搜索、名片、星标 |
| 即时通讯 IM | 是 | 是 | 消息可靠送达、未读数、重连 |
| 工作台/通知 | 是 | 是 | 角标、实时通知、公告 |
| 文档 | 是 | 否 | 富文本展示、版本冲突 |
| 日程 | 是 | 是 | 到期提醒、参与人状态 |
| 会议 | 是 | 是 | WebRTC Mesh 信令、权限、主持人控制 |
| 审批 | 是 | 是 | 审批流状态、抢办保护 |
| 邮箱 | 是 | 否 | 系统内模拟邮件 |
| 云盘 | 是 | 否 | 上传、预览、回收站 |
| 好友 | 是 | 是 | 跨企业搜索、申请、拉黑 |
| 操作日志 | 是 | 否 | 超管审计 |

---

## 五、团队分工建议

团队配置：4 个开发、2 个运维。由于三端统一使用同一套接口，建议按“业务复杂度 + 端适配难度”分工。

| 角色 | 建议负责人 | 主要任务 |
|---|---|---|
| 开发 1：后端/API 主负责人 | 1 人 | 后端接口维护、接口文档同步、权限和错误码校准、数据库变更 |
| 开发 2：Web/H5 负责人 | 1 人 | 工作台、IM、审批、文档、云盘等 Web/H5 页面 |
| 开发 3：微信小程序负责人 | 1 人 | 小程序登录态、权限适配、接口封装、文件上传预览兼容 |
| 开发 4：Android 负责人 | 1 人 | App 打包、Socket 通信、会议 WebRTC、Android WebView/权限问题 |
| 运维 1：部署负责人 | 1 人 | 宝塔/Nginx、HTTPS、Docker、域名、反代、上传目录映射 |
| 运维 2：测试与稳定性负责人 | 1 人 | 接口测试、日志排查、监控、备份、回滚演练 |

难度排序建议：Android 会议与 Socket > 小程序文件/权限适配 > Web/H5 普通业务页 > 运维部署与反代 > 后端文档校准。会议模块由 Android 负责人和后端负责人共同联调。

---

## 六、关键对接地址

| 类型 | 地址 | 说明 |
|---|---|---|
| REST | `https://api.syx0304.top/api/v1` | 所有业务接口统一前缀 |
| Socket.IO | `https://api.syx0304.top` | IM、通知、会议、好友实时事件 |
| 上传文件 | `https://api.syx0304.top/uploads/<文件名>` | 注意路径是 `/uploads/`，不是 `/upload/` |
| 健康检查 | `GET /api/v1/health` | 部署后 smoke test |

---

## 七、文档更新日志

| 版本 | 日期 | 更新内容 |
|---|---|---|
| v1.1.1-doc | 2026-07-06 | 根据项目模板填充飞书企业协作平台真实需求、接口、技术和部署文档 |