# 项目结构说明

## 📁 整理后的目录结构

```
compliance/
├── 🐍 核心应用文件
│   ├── api_server.py           # API服务器 (端口5050)
│   ├── history_viewer.py       # 历史查看器 (端口5051)
│   ├── run_api_tests.py        # 命令行测试工具
│   └── requirements.txt        # Python依赖
│
├── 🐳 Docker相关文件
│   ├── docker-build.sh         # Docker构建脚本
│   ├── docker-compose.yml      # Docker Compose配置
│   └── docker/
│       ├── Dockerfile.service  # 主Dockerfile (Supervisor方案)
│       ├── Dockerfile.simple   # 简化版Dockerfile (Shell脚本方案)
│       ├── supervisord.conf    # Supervisor配置
│       └── start_services.sh   # 多服务启动脚本
│
├── 🧪 测试文件
│   └── tests/
│       ├── test_pdf_optimization.py      # PDF优化测试
│       ├── test_strictness_level_pdf.py  # 严格等级测试
│       ├── test_updated_summary.py       # 摘要更新测试
│       ├── test_multi_service.py         # 多服务测试
│       ├── test_real_data_pdf.py         # 真实数据测试
│       └── test-docker.sh               # Docker测试脚本
│
├── 📚 文档文件
│   └── docs/
│       ├── Docker_Deployment_Guide.md           # Docker部署指南
│       ├── Docker_Quick_Reference.md            # Docker快速参考
│       ├── Multi_Service_Docker_Summary.md      # 多服务Docker总结
│       ├── PDF_Fix_Summary.md                   # PDF修复总结
│       ├── PDF_Report_Optimization_Guide.md     # PDF报告优化指南
│       ├── Strictness_Level_Feature_Summary.md  # 严格等级功能总结
│       ├── Summary_Update_Complete.md           # 摘要更新完成总结
│       └── Project_Structure.md                 # 本文档
│
├── 🌐 Web相关文件
│   ├── nginx/
│   │   └── nginx.conf          # Nginx反向代理配置
│   ├── static/                 # 静态文件
│   └── templates/              # HTML模板
│
├── 📊 数据和配置
│   ├── assets/                 # 资源文件
│   ├── memory-bank/           # 项目文档和上下文
│   ├── test_reports/          # 测试报告目录 (运行时生成)
│   ├── uploads/               # 上传文件目录 (运行时生成)
│   └── logs/                  # 日志目录 (运行时生成)
│
└── 🔧 配置文件
    ├── .gitignore             # Git忽略文件
    ├── .dockerignore          # Docker忽略文件
    └── README.md              # 项目说明
```

## 📋 文件分类说明

### 核心应用文件
- **api_server.py**: 主要的API测试服务，提供Web界面和API端点
- **history_viewer.py**: 测试历史查看器，用于管理和查看测试记录
- **run_api_tests.py**: 命令行测试工具，支持批量测试和PDF生成

### Docker相关文件
- **docker-build.sh**: 自动化Docker构建和部署脚本
- **docker-compose.yml**: Docker Compose配置，支持一键部署
- **docker/**: Docker相关配置文件目录
  - **Dockerfile.service**: 使用Supervisor管理多进程的主Dockerfile
  - **Dockerfile.simple**: 使用Shell脚本管理的简化版Dockerfile
  - **supervisord.conf**: Supervisor进程管理配置
  - **start_services.sh**: 多服务启动脚本

### 测试文件
- **tests/**: 所有测试脚本的集中目录
  - PDF相关测试：验证PDF报告生成功能
  - 严格等级测试：验证测试用例分离功能
  - 多服务测试：验证Docker多服务部署
  - Docker测试：验证Docker镜像构建和运行

### 文档文件
- **docs/**: 所有文档的集中目录
  - 部署指南：详细的Docker部署说明
  - 功能总结：各个功能的实现总结
  - 快速参考：常用命令和操作指南

## 🎯 整理的优势

### 1. 清晰的结构
- 按功能分类，便于查找和维护
- 核心代码与辅助文件分离
- 文档和测试独立管理

### 2. 简化的根目录
- 只保留最重要的核心文件
- 减少根目录的文件数量
- 提高项目的可读性

### 3. 便于维护
- 相关文件集中管理
- 便于版本控制和协作
- 易于添加新的测试和文档

### 4. Docker友好
- Docker相关文件集中管理
- 路径引用已更新
- 支持多种部署方案

## 🔄 迁移说明

### 已完成的文件移动
1. **Docker文件** → `docker/` 目录
2. **测试脚本** → `tests/` 目录  
3. **文档文件** → `docs/` 目录

### 已更新的路径引用
1. **docker-build.sh**: 更新Dockerfile路径为 `docker/Dockerfile.service`
2. **docker-compose.yml**: 更新dockerfile路径
3. **Dockerfile**: 更新内部文件复制路径

### Git忽略文件
- 完善的.gitignore文件，包含Python、Docker、IDE等常见忽略项
- 保护敏感文件和临时文件
- 避免提交不必要的文件

## 🚀 使用建议

### 开发时
- 在根目录运行核心应用
- 使用 `tests/` 目录中的脚本进行测试
- 参考 `docs/` 目录中的文档

### 部署时
- 使用 `./docker-build.sh` 进行Docker部署
- 或使用 `docker-compose up -d` 进行服务编排
- 查看 `docs/Docker_Deployment_Guide.md` 获取详细指导

### 维护时
- 新的测试脚本放入 `tests/` 目录
- 新的文档放入 `docs/` 目录
- Docker相关修改在 `docker/` 目录中进行

这样的结构使项目更加专业和易于管理！