# 仿飞书应用-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**: 2
- **Created**: 2026-07-02
- **Last Updated**: 2026-07-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 仿飞书应用-2班3组

## 📌 项目简介

本项目为高职软件技术专业（全栈开发方向）暑期实习的分组实战项目，目标是**全量复刻飞书（Lark）的核心业务功能**，覆盖即时通讯、协同文档、视频会议、日历、审批、云盘、通讯录、应用中心等核心模块，最终交付一个可在生产环境运行的**企业级协同办公平台**。

项目采用前后端分离架构，前端多端统一，后端高内聚低耦合，强调**业务完整度**、**工程规范**、**文档可追溯**与**可交付性**。

> ⚠️ **实习要求**：本项目不是 Demo 演示，而是面向真实业务场景的"准生产级"交付物，所有功能必须可演示、可回归、可交付。

---

## 🎯 业务目标（全量功能复刻清单）

| 序号 | 业务模块 | 核心功能 | 优先级 |
| :--: | :------- | :------- | :----: |
| 1 | 用户中心 | 注册/登录/找回密码/SSO 单点登录/三方登录 | P0 |
| 2 | 通讯录 | 组织架构/部门管理/员工名片/搜索 | P0 |
| 3 | 即时通讯（IM） | 单聊/群聊/消息已读/历史消息/文件传输/消息撤回 | P0 |
| 4 | 协同文档 | 富文本编辑/多人实时协作/版本历史/评论 | P0 |
| 5 | 视频会议 | 预约会议/即时会议/屏幕共享/会议录制 | P1 |
| 6 | 日历 | 日程创建/重复事件/提醒/共享日历 | P1 |
| 7 | 审批（OA） | 自定义表单/审批流/加签/转交 | P1 |
| 8 | 云盘 | 文件上传下载/在线预览/权限管理/分享 | P1 |
| 9 | 应用中心 | 应用上下架/工作台配置 | P2 |
| 10 | 消息通知 | 系统通知/邮件/短信/站内信 | P1 |
| 11 | 管理后台 | 用户管理/权限管理/数据字典/操作日志 | P0 |
| 12 | 开放平台 | OpenAPI/Webhook/应用鉴权 | P2 |

---

## 🛠️ 技术栈

### 前端
- **核心框架**：Vue 3（Composition API + `<script setup>`）
- **样式方案**：Tailwind CSS（Utility-First，配合设计系统）
- **状态管理**：Pinia
- **路由**：Vue Router 4
- **HTTP**：Axios + 请求拦截器统一封装
- **构建工具**：Vite
- **跨端框架**（多端）：Uni-app / Taro（输出 H5 + iOS + Android + **微信小程序**）
- **桌面端框架**（PC 客户端）：Electron（生态成熟，跨平台打包 .exe / .dmg / .AppImage） / Tauri（Rust 内核，轻量高性能）
- **UI 组件库**：自研组件库 + Headless UI（PC Web）/ Naive UI（PC 客户端）/ Vant（移动端）

### 多端覆盖
| 端 | 形态 | 技术实现 |
| :--: | :--: | :--: |
| 💻 PC 网页端 | Web | Vue 3 + Vite + Tailwind CSS（浏览器访问） |
| 🖥️ PC 客户端 | Desktop | Electron / Tauri 跨平台打包（.exe / .dmg / .AppImage） |
| 🍎 iOS 端 | App | Uni-app / Taro 编译打包 |
| 🤖 Android 端 | App | Uni-app / Tauri 编译打包 |

### 后端
- **运行时**：.NET 10
- **Web 框架**：ASP.NET Core 10
- **ORM**：EF Core 10 / Dapper
- **数据库**：PostgreSQL 16+（pgsql）
- **缓存**：Redis 7
- **消息队列**：RabbitMQ
- **实时通信**：SignalR（IM、视频会议信令）
- **鉴权**：JWT + OAuth 2.0
- **对象存储**：MinIO（文件/图片/视频）
- **搜索**：Elasticsearch 8

### 运维 / 部署
- **容器化**：Docker + Docker Compose
- **反向代理**：Nginx
- **CI/CD**：GitHub Actions / Gitee Go
- **监控**：Prometheus + Grafana
- **日志**：Serilog + ELK

---

## 📁 仓库目录结构

```
仿飞书应用-2班3组/
├── docs/                    # 📚 项目文档（强制要求：每个过程必须有md+配图）
│   ├── 00-项目概览/
│   ├── 01-需求分析/
│   ├── 02-原型设计/
│   ├── 03-技术选型/
│   ├── 04-数据库设计/
│   ├── 05-接口设计/
│   ├── 06-前端开发/
│   ├── 07-后端开发/
│   ├── 08-联调测试/
│   ├── 09-部署上线/
│   ├── 10-运维手册/
│   └── 11-周报与复盘/
├── frontend/                # 前端工程（Vue 3 + Tailwind）
│   ├── pc-web/             # PC 网页端（Web，浏览器访问）
│   ├── pc-client/          # PC 客户端（Electron / Tauri 桌面应用）
│   ├── mobile-h5/          # H5
│   ├── mobile-app/         # iOS + Android（Uni-app / Taro 编译）
│   └── mini-program/       # 微信小程序（Uni-app 编译输出到微信开发者工具）
├── backend/                 # 后端工程（.NET 10 + pgsql）
│   ├── src/
│   ├── tests/
│   └── scripts/
├── deploy/                  # 部署相关
│   ├── docker/
│   ├── nginx/
│   └── ci-cd/
├── .gitignore
├── README.md
└── LICENSE
```

---

## 📚 文档规范（强约束）
> 🚨 **必读**：项目立项书已就位，请先阅读 [docs/00-项目概览/项目立项书.md](docs/00-项目概览/项目立项书.md)，了解项目背景、范围、团队分工与里程碑后再开展具体工作。



> 🚨 **本项目硬性要求：开发的每一个过程都必须有完整、详实的 md 文档，文档中必须有完整、具体的配图！**

### 1. 文档形式
- **格式**：Markdown（`.md`）
- **存放位置**：`docs/` 目录下，按阶段分文件夹归档
- **命名规范**：`XX-阶段-模块-描述.md`（如 `06-前端开发-IM-消息列表组件.md`）

### 2. 文档必备内容
每篇文档必须包含以下章节（缺一不可）：

| 章节 | 说明 | 是否必含配图 |
| :--: | :--: | :--: |
| 一、背景与目标 | 为什么要做、做到什么程度 | ✅ |
| 二、需求分析 | 用户故事、业务流程 | ✅ |
| 三、方案设计 | 技术方案、架构图、时序图 | ✅ |
| 四、数据库/接口设计 | 表结构、字段说明、接口契约 | ✅ |
| 五、核心实现 | 关键代码 + 流程截图 + 运行截图 | ✅ |
| 六、测试用例 | 功能测试 + 边界用例 | ✅ |
| 七、问题与复盘 | 踩坑记录、解决方案 | ✅ |
| 八、参考资料 | 链接、文档版本 | ❌ |

### 3. 配图要求
- **工具**：推荐 draw.io（架构图/流程图）、ProcessOn、Snipaste（截图）
- **存放**：`docs/` 下的 `images/` 子目录，命名与文档一致
- **格式**：PNG（截图）/ SVG（矢量图）
- **清晰度**：1080P 以上，关键位置需红框/箭头标注
- **数量要求**：每篇文档 **≥ 5 张配图**

### 4. 文档提交节奏
- **每完成一个功能模块** → 当天提交对应 md
- **每日下班前** → 提交 `docs/11-周报与复盘/日报-YYYY-MM-DD.md`
- **每周五** → 提交周报 + 进度截图

---

## 👥 团队分工（全栈开发 + 实施运维 双线并行）

> 🚨 **组内成员包含"全栈开发"和"实施运维"两个方向，必须保证两个方向都有明确任务，不能让任何一方无事可做。**

### 角色定位

| 方向 | 角色 | 核心职责 |
| :--: | :--: | :--: |
| 💻 全栈开发 | 前端工程师 | Vue 3 + Tailwind 多端开发 |
| 💻 全栈开发 | 后端工程师 | .NET 10 + pgsql 接口开发 |
| 🔧 实施运维 | 实施工程师 | 客户对接、需求调研、数据初始化、培训 |
| 🔧 运维工程师 | 部署、CI/CD、监控、故障排查 |

### 双线任务并行表（示例，按实际组员人数调整）

| 周次 | 全栈开发线 | 实施运维线 |
| :--: | :-- | :-- |
| W1 | 需求评审、技术选型、原型设计 | 客户调研、需求收集、文档整理 |
| W2 | 架构设计、数据库设计、接口设计 | 客户环境调研、服务器选型 |
| W3-W4 | 用户中心、通讯录开发 | 测试环境部署、数据初始化脚本 |
| W5-W6 | IM、协同文档开发 | CI/CD 流水线搭建、监控告警 |
| W7-W8 | 视频会议、日历开发 | 生产环境部署、压力测试 |
| W9-W10 | 审批、云盘、消息通知 | 用户培训、使用手册编写 |
| W11-W12 | 联调、Bug 修复、回归 | 试运行支持、问题收集与反馈 |
| W13-W14 | 性能优化、文档完善 | 项目验收、运维交接文档 |

### 任务分配模板（每位组员维护自己的清单）

```markdown
## 成员：XXX（全栈开发/实施运维）

### 本周任务
- [ ] 任务1（关联 issue/文档链接）
- [ ] 任务2

### 完成情况
- 任务1：✅ 已完成，文档：[docs/xxx.md](docs/xxx.md)
- 任务2：🚧 进行中，阻塞点：xxx

### 下周计划
- [ ] 任务3
- [ ] 任务4
```

---

## 📐 开发规范

### Git 规范
- **主分支**：`main`（稳定）/ `develop`（开发）
- **功能分支**：`feat/模块名-功能名`（如 `feat/im-message-list`）
- **修复分支**：`fix/问题描述`
- **提交规范**：`<type>(<scope>): <subject>`，遵循 Conventional Commits
- **代码审查**：所有 PR 必须至少 1 人 Review 通过才能合并

### 代码规范
- **前端**：ESLint + Prettier + Vue 3 风格指南
- **后端**：`dotnet format` + EditorConfig + C# 编码规范
- **命名**：驼峰（变量）/ 帕斯卡（类）/ 全大写下划线（常量）

### 接口规范
- **RESTful** 风格，统一前缀 `/api/v1/`
- **统一响应结构**：`{ code, message, data, traceId }`
- **错误码**：分模块管理，全局唯一
- **文档**：使用 Swagger / OpenAPI 3.0 自动生成

---

## 🚀 快速开始

### 环境要求
- Node.js ≥ 18
- pnpm ≥ 8（或 npm ≥ 9）
- .NET SDK 10
- PostgreSQL ≥ 16
- Redis ≥ 7
- Docker ≥ 24

### 启动步骤

```bash
# 1. 克隆仓库
git clone <仓库地址>
cd fang-feishu-app-class2-groupN

# 2. 启动中间件（pgsql + redis + minio）
docker compose -f deploy/docker/docker-compose.dev.yml up -d

# 3. 启动后端
cd backend
dotnet restore
dotnet ef database update
dotnet run

# 4. 启动前端
cd frontend/pc-web
pnpm install
pnpm dev

# 5. 访问
# 前端：http://localhost:5173
# 后端 API：http://localhost:5000
# Swagger：http://localhost:5000/swagger
```

---

## 🤝 仓库使用规范

1. **禁止** 直接 push 到 `main` / `develop` 分支
2. **禁止** 提交 `node_modules/`、`bin/`、`obj/`、`*.user`、`appsettings.Development.json` 等敏感/体积大的文件
3. **必须** 在 `docs/` 中维护对应过程的 md 文档和配图
4. **必须** 为每个功能模块编写单元测试，后端覆盖率 ≥ 60%
5. **必须** 在 PR 描述中关联对应的文档路径

---

## 📅 项目里程碑

| 阶段 | 时间 | 交付物 |
| :--: | :--: | :-- |
| 需求 + 设计 | W1-W2 | 需求文档、原型图、架构图、数据库 ER 图 |
| 第一轮开发 | W3-W6 | 用户中心、通讯录、IM 跑通 |
| 第二轮开发 | W7-W10 | 文档、会议、日历、审批、云盘 |
| 联调 + 测试 | W11-W12 | 测试报告、Bug 清零 |
| 部署 + 验收 | W13-W14 | 生产环境部署、培训手册、验收报告 |

---

## 📞 联系方式

- **组长**：（填写）
- **指导老师**：（填写）
- **组内沟通群：（填写）
- **问题反馈**：通过 GitHub/Gitee Issues 提交

---

## 📄 License

本项目仅用于高职软件技术专业暑期实习教学使用，未经许可不得用于商业用途。