# doc-review

**Repository Path**: szn/doc-review

## Basic Information

- **Project Name**: doc-review
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档评审系统 (Document Review System)

企业级文档管理和评审平台，支持文档上传、在线预览、多人评审、流程审批等功能。

## 📋 项目结构

```
clawd/
├── doc-review-backend/     # 后端项目 (Spring Boot 3.2)
├── doc-review-frontend/    # 前端项目 (Vue 3 + TypeScript)
├── docs/                   # 设计文档
│   ├── api-design.md       # API接口设计
│   ├── database-design.md  # 数据库设计
│   └── init-database.sql   # 建表SQL
└── README.md
```

## 🛠 技术栈

### 后端
- Spring Boot 3.2.0
- MyBatis Plus 3.5.5
- Sa-Token (权限认证)
- MySQL 8.0
- Redis
- Knife4j (API文档)

### 前端
- Vue 3.4
- TypeScript 5.3
- Vite 5
- Element Plus 2.5
- Pinia
- Vue Router 4

## 🚀 快速开始

### 1. 数据库初始化

```bash
# 创建数据库
CREATE DATABASE doc_review DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

# 执行建表SQL
mysql -u root -p doc_review < docs/init-database.sql
```

### 2. 后端启动

```bash
cd doc-review-backend

# 修改配置
vi src/main/resources/application-dev.yml
# 配置数据库连接、Redis等

# 启动
mvn spring-boot:run

# 访问API文档
# http://localhost:8080/api/doc.html
```

### 3. 前端启动

```bash
cd doc-review-frontend

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 访问
# http://localhost:3000
```

## 📦 功能模块

### 系统管理
- 用户管理：用户增删改查、密码重置、角色分配
- 组织管理：组织架构树形管理
- 角色管理：角色权限配置
- 菜单管理：动态菜单配置
- AD域配置：AD域连接、用户同步

### 文档管理
- 分类管理：文档分类树形管理
- 文档上传：支持多格式文档上传
- 文档预览：在线预览文档
- 版本管理：文档版本控制
- 下载控制：权限控制下载

### 评审管理
- 流程配置：配置评审流程模板
- 任务管理：创建和管理评审任务
- 评审执行：执行评审、添加评论
- 截图标注：对文档截图标注评论
- 评审报告：自动生成评审报告

## 📊 数据库设计

共21张表：
- 系统管理：sys_user, sys_org, sys_role, sys_menu, sys_user_role, sys_role_menu, sys_ad_config, sys_data_permission, sys_oper_log
- 文档管理：doc_category, doc_info, doc_version, doc_download_log
- 评审管理：review_flow_template, review_flow_node, review_task, review_record, review_comment, review_report

## 👤 默认账号

```
管理员：admin / 123456
```

## 📝 开发进度

- [x] 需求分析
- [x] 数据库设计
- [x] API接口设计
- [x] 后端开发
- [x] 前端开发
- [ ] 测试用例
- [ ] 部署上线

## 📄 License

MIT License