更新项目文件结构,统一文档风格
48
README.md
@@ -8,25 +8,26 @@
|
||||
|
||||
```
|
||||
.
|
||||
├── frontend/ # 前端项目
|
||||
│ ├── website/ # 官网首页
|
||||
├── backend/ # 后端项目
|
||||
├── admin-system/ # 管理后台系统
|
||||
│ ├── farming-management/ # 养殖管理系统
|
||||
│ ├── bank-supervision/ # 银行监管系统
|
||||
│ ├── insurance-supervision/ # 保险监管系统
|
||||
│ ├── government-platform/ # 政府监管平台
|
||||
│ ├── cattle-trading/ # 活牛交易系统
|
||||
│ ├── mall-management/ # 商城管理系统
|
||||
│ ├── dashboard/ # 大屏可视化系统
|
||||
│ └── mini-programs/ # 微信小程序矩阵
|
||||
│ ├── beef-mall/ # 牛肉商城小程序
|
||||
│ ├── farming-manager/ # 养殖管理小程序
|
||||
│ ├── bank-supervision/ # 银行监管小程序
|
||||
│ ├── insurance-supervision/ # 保险监管小程序
|
||||
│ ├── cattle-trading/ # 活牛交易小程序
|
||||
│ ├── gov-supervision/ # 政府监管小程序
|
||||
│ ├── data-platform/ # 数据中台小程序
|
||||
│ └── ai-capabilities/ # AI能力小程序
|
||||
├── backend/ # 后端项目
|
||||
│ └── dashboard/ # 大屏可视化系统
|
||||
├── website/ # 官网项目
|
||||
├── mini_program/ # 微信小程序矩阵
|
||||
│ ├── beef-mall/ # 牛肉商城小程序
|
||||
│ ├── farming-manager/ # 养殖管理小程序
|
||||
│ ├── bank-supervision/ # 银行监管小程序
|
||||
│ ├── insurance-supervision/ # 保险监管小程序
|
||||
│ ├── cattle-trading/ # 活牛交易小程序
|
||||
│ ├── gov-supervision/ # 政府监管小程序
|
||||
│ ├── data-platform/ # 数据中台小程序
|
||||
│ └── ai-capabilities/ # AI能力小程序
|
||||
├── docs/ # 文档目录
|
||||
│ ├── api/ # API服务
|
||||
│ │ ├── farming/ # 养殖管理API
|
||||
│ │ ├── finance/ # 金融服务API
|
||||
@@ -47,10 +48,11 @@
|
||||
│ │ └── user-center-service/ # 用户中心服务
|
||||
│ ├── database/ # 数据库脚本
|
||||
│ └── utils/ # 工具函数
|
||||
├── docs/ # 文档
|
||||
├── docs/ # 文档目录
|
||||
│ ├── design/ # 设计文档
|
||||
│ ├── requirements/ # 需求文档
|
||||
│ └── development_plans/ # 开发计划文档
|
||||
├── test/ # 测试文件目录
|
||||
└── deployment/ # 部署相关配置
|
||||
```
|
||||
|
||||
@@ -58,13 +60,17 @@
|
||||
|
||||
详细文档请参见 [docs/README.md](docs/README.md) 文件,其中包含所有系统文档的完整列表和链接。
|
||||
|
||||
- `docs/requirements/` - 需求文档
|
||||
- `docs/design/` - 设计文档
|
||||
- `docs/development_plans/` - 开发计划
|
||||
- `docs/PROJECT_STRUCTURE.md` - 项目结构说明文档
|
||||
|
||||
## 技术栈
|
||||
|
||||
### 前端技术栈
|
||||
- **官网首页**: HTML5 + CSS3 + JavaScript
|
||||
- **后台管理系统**: Vue.js 3 + TypeScript + Ant Design Vue + Pinia
|
||||
- **大屏可视化系统**: Vue.js 3 + ECharts + 自定义可视化组件
|
||||
- **微信小程序矩阵**: 微信小程序原生开发 + uni-app
|
||||
### 技术栈
|
||||
- **官网项目 (website/)**: HTML5 + CSS3 + JavaScript
|
||||
- **管理后台系统 (admin-system/)**: Vue.js 3 + TypeScript + Ant Design Vue + Pinia
|
||||
- **微信小程序矩阵 (mini_program/)**: 微信小程序原生开发 + uni-app
|
||||
|
||||
### 后端技术栈
|
||||
- **API服务**: Node.js + Express.js + TypeScript + RESTful API
|
||||
@@ -80,8 +86,8 @@
|
||||
|
||||
## 开发说明
|
||||
|
||||
1. 前端项目使用 Vite 构建
|
||||
2. 后端项目基于 Node.js 和 Express.js
|
||||
1. 管理后台系统 (admin-system/) 使用 Vite 构建
|
||||
2. 后端项目 (backend/) 基于 Node.js 和 Express.js
|
||||
3. 各个子系统可以独立开发和部署
|
||||
4. 微服务架构便于扩展和维护
|
||||
|
||||
|
||||
183
docs/PROJECT_STRUCTURE.md
Normal file
@@ -0,0 +1,183 @@
|
||||
# 项目目录结构说明
|
||||
|
||||
## 整体结构
|
||||
|
||||
```
|
||||
xlxumu/
|
||||
├── backend/ # 后端服务目录
|
||||
├── admin-system/ # 管理后台系统目录
|
||||
├── website/ # 官网项目目录
|
||||
├── mini_program/ # 微信小程序矩阵目录
|
||||
├── docs/ # 项目文档目录
|
||||
├── test/ # 测试文件目录
|
||||
├── deployment/ # 部署配置目录
|
||||
└── scripts/ # 工具脚本目录
|
||||
```
|
||||
|
||||
## 详细目录说明
|
||||
|
||||
### 1. 后端服务目录 (backend/)
|
||||
```
|
||||
backend/
|
||||
├── api/ # API接口服务
|
||||
│ ├── farming/ # 养殖管理API
|
||||
│ ├── finance/ # 金融服务API
|
||||
│ ├── government/ # 政府监管API
|
||||
│ ├── trade/ # 交易管理API
|
||||
│ ├── mall/ # 商城管理API
|
||||
│ ├── data-platform/ # 数据中台API
|
||||
│ ├── ai/ # AI能力API
|
||||
│ └── user-center/ # 用户中心API
|
||||
├── services/ # 微服务模块
|
||||
│ ├── farming-service/ # 养殖管理服务
|
||||
│ ├── finance-service/ # 金融服务
|
||||
│ ├── government-service/ # 政府监管服务
|
||||
│ ├── trade-service/ # 交易管理服务
|
||||
│ ├── mall-service/ # 商城管理服务
|
||||
│ ├── data-platform-service/ # 数据中台服务
|
||||
│ ├── ai-service/ # AI能力服务
|
||||
│ └── user-center-service/ # 用户中心服务
|
||||
├── database/ # 数据库脚本和设计
|
||||
└── utils/ # 工具函数和公共模块
|
||||
```
|
||||
|
||||
### 2. 管理后台系统目录 (admin-system/)
|
||||
```
|
||||
admin-system/
|
||||
├── farming-management/ # 养殖管理系统
|
||||
├── bank-supervision/ # 银行监管系统
|
||||
├── insurance-supervision/ # 保险监管系统
|
||||
├── government-platform/ # 政府监管平台
|
||||
├── cattle-trading/ # 活牛交易系统
|
||||
├── mall-management/ # 商城管理系统
|
||||
└── dashboard/ # 大屏可视化系统
|
||||
```
|
||||
|
||||
### 3. 官网项目目录 (website/)
|
||||
```
|
||||
website/
|
||||
├── index.html # 首页
|
||||
├── about.html # 关于页面
|
||||
├── data.html # 数据展示页面
|
||||
├── news.html # 新闻页面
|
||||
├── css/ # 样式文件
|
||||
├── js/ # JavaScript文件
|
||||
└── images/ # 图片资源
|
||||
```
|
||||
|
||||
### 4. 微信小程序矩阵目录 (mini_program/)
|
||||
```
|
||||
mini_program/
|
||||
├── beef-mall/ # 牛肉商城小程序
|
||||
├── farming-manager/ # 养殖管理小程序
|
||||
├── bank-supervision/ # 银行监管小程序
|
||||
├── insurance-supervision/ # 保险监管小程序
|
||||
├── cattle-trading/ # 活牛交易小程序
|
||||
├── gov-supervision/ # 政府监管小程序
|
||||
├── data-platform/ # 数据中台小程序
|
||||
└── ai-capabilities/ # AI能力小程序
|
||||
```
|
||||
|
||||
### 5. 项目文档目录 (docs/)
|
||||
```
|
||||
docs/
|
||||
├── design/ # 设计文档
|
||||
│ ├── ARCHITECTURE.md # 系统架构设计
|
||||
│ ├── DEVELOPMENT_PLAN.md # 开发计划
|
||||
│ ├── api/ # API设计文档
|
||||
│ ├── database/ # 数据库设计文档
|
||||
│ └── system_architecture.svg # 系统架构图
|
||||
├── requirements/ # 需求文档
|
||||
│ ├── SYSTEM_REQUIREMENTS.md # 系统需求
|
||||
│ ├── FARMING_MANAGEMENT_REQUIREMENTS.md # 养殖管理需求
|
||||
│ ├── FINANCIAL_SERVICES_REQUIREMENTS.md # 金融服务需求
|
||||
│ ├── GOVERNMENT_SUPERVISION_REQUIREMENTS.md # 政府监管需求
|
||||
│ ├── MALL_MANAGEMENT_REQUIREMENTS.md # 商城管理需求
|
||||
│ ├── MARKET_TRADING_REQUIREMENTS.md # 市场交易需求
|
||||
│ ├── DATA_PLATFORM_REQUIREMENTS.md # 数据中台需求
|
||||
│ ├── AI_CAPABILITIES_REQUIREMENTS.md # AI能力需求
|
||||
│ ├── SYSTEM_INTEGRATION_REQUIREMENTS.md # 系统集成需求
|
||||
│ └── WEBSITE_REQUIREMENTS.md # 官网需求
|
||||
├── development_plans/ # 开发计划文档
|
||||
│ ├── backend_api_development_plan.md # 后端API开发计划
|
||||
│ ├── farming_management_development_plan.md # 养殖管理开发计划
|
||||
│ ├── bank_supervision_development_plan.md # 银行监管开发计划
|
||||
│ ├── insurance_supervision_development_plan.md # 保险监管开发计划
|
||||
│ ├── government_platform_development_plan.md # 政府平台开发计划
|
||||
│ ├── cattle_trading_development_plan.md # 活牛交易开发计划
|
||||
│ ├── mall_management_development_plan.md # 商城管理开发计划
|
||||
│ ├── dashboard_development_plan.md # 大屏可视化开发计划
|
||||
│ └── website_development_plan.md # 官网开发计划
|
||||
├── API_DOCUMENTATION_STANDARD.md # API文档规范标准
|
||||
├── API_DOCUMENTATION_CHECKLIST.md # API文档检查清单
|
||||
├── DOCUMENTATION_MAINTENANCE_PROCESS.md # 文档维护流程
|
||||
└── PROJECT_STRUCTURE.md # 项目结构说明(本文档)
|
||||
```
|
||||
|
||||
### 6. 测试文件目录 (test/)
|
||||
```
|
||||
test/
|
||||
├── unit/ # 单元测试
|
||||
├── integration/ # 集成测试
|
||||
├── e2e/ # 端到端测试
|
||||
└── performance/ # 性能测试
|
||||
```
|
||||
|
||||
### 7. 部署配置目录 (deployment/)
|
||||
```
|
||||
deployment/
|
||||
├── docker/ # Docker配置
|
||||
├── kubernetes/ # Kubernetes配置
|
||||
├── nginx/ # Nginx配置
|
||||
├── scripts/ # 部署脚本
|
||||
└── README.md # 部署说明文档
|
||||
```
|
||||
|
||||
### 8. 工具脚本目录 (scripts/)
|
||||
```
|
||||
scripts/
|
||||
└── update_api_docs.py # API文档更新脚本
|
||||
```
|
||||
|
||||
## 目录命名规范
|
||||
|
||||
1. **后端目录**: 使用英文单数形式,如 `backend/`
|
||||
2. **前端目录**: 使用英文单数形式,如 `admin-system/`
|
||||
3. **文档目录**: 使用英文复数形式,如 `docs/`
|
||||
4. **子目录**: 使用英文连字符分隔,如 `farming-management/`
|
||||
5. **API目录**: 使用英文单数形式,如 `api/farming/`
|
||||
|
||||
## 开发规范
|
||||
|
||||
1. **模块化开发**: 每个功能模块独立开发,便于维护和扩展
|
||||
2. **前后端分离**: 后端提供RESTful API,前端通过API调用数据
|
||||
3. **文档驱动**: 所有功能开发前必须先完成需求文档和设计文档
|
||||
4. **测试覆盖**: 每个模块都需要有相应的测试用例
|
||||
5. **代码规范**: 遵循统一的代码风格和命名规范
|
||||
|
||||
## 部署说明
|
||||
|
||||
1. **独立部署**: 每个子系统可以独立部署和运行
|
||||
2. **微服务架构**: 后端采用微服务架构,支持水平扩展
|
||||
3. **容器化**: 支持Docker容器化部署
|
||||
4. **自动化部署**: 提供自动化部署脚本和配置
|
||||
|
||||
## 维护说明
|
||||
|
||||
1. **文档更新**: 任何代码变更都需要同步更新相关文档
|
||||
2. **版本控制**: 使用Git进行版本控制,遵循语义化版本规范
|
||||
3. **代码审查**: 所有代码提交都需要经过代码审查
|
||||
4. **持续集成**: 配置CI/CD流水线,自动化测试和部署
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [API文档规范标准](./API_DOCUMENTATION_STANDARD.md)
|
||||
- [API文档检查清单](./API_DOCUMENTATION_CHECKLIST.md)
|
||||
- [文档维护流程](./DOCUMENTATION_MAINTENANCE_PROCESS.md)
|
||||
- [系统架构设计](./design/ARCHITECTURE.md)
|
||||
- [开发计划](./design/DEVELOPMENT_PLAN.md)
|
||||
|
||||
---
|
||||
|
||||
**最后更新**: 2024年1月20日
|
||||
**版本**: v1.0.0
|
||||
75418
frontend/dashboard/node_modules/.vite/deps/echarts.js
generated
vendored
7
frontend/dashboard/node_modules/.vite/deps/echarts.js.map
generated
vendored
|
Before Width: | Height: | Size: 304 KiB After Width: | Height: | Size: 304 KiB |
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 79 KiB |
|
Before Width: | Height: | Size: 1000 KiB After Width: | Height: | Size: 1000 KiB |