更新项目文件结构,统一文档风格

This commit is contained in:
ylweng
2025-09-10 23:57:44 +08:00
parent 3ae7b4db8c
commit 68c6c23f5a
12 changed files with 410 additions and 24195 deletions

View File

@@ -4,7 +4,7 @@
```
xlxumu/
├── backend/ # 后端服务目录
├── backend-java/ # 后端服务目录 (Java微服务架构)
├── admin-system/ # 管理后台系统目录
├── website/ # 官网项目目录
├── mini_program/ # 微信小程序矩阵目录
@@ -16,19 +16,14 @@ xlxumu/
## 详细目录说明
### 1. 后端服务目录 (backend/)
### 1. 后端服务目录 (backend-java/)
```
backend/
├── api/ # API接口服务
│ ├── farming/ # 养殖管理API
│ ├── finance/ # 金融服务API
│ ├── government/ # 政府监管API
│ ├── trade/ # 交易管理API
│ ├── mall/ # 商城管理API
│ ├── data-platform/ # 数据中台API
│ ├── ai/ # AI能力API
│ └── user-center/ # 用户中心API
├── services/ # 微服务模块
backend-java/
├── api/ # API网关模块
├── gateway/ # Spring Cloud Gateway网关服务
├── registry/ # Eureka服务注册中心
├── config-server/ # Spring Cloud配置中心
├── services/ # 微服务模块
│ ├── farming-service/ # 养殖管理服务
│ ├── finance-service/ # 金融服务
│ ├── government-service/ # 政府监管服务
@@ -37,8 +32,23 @@ backend/
│ ├── data-platform-service/ # 数据中台服务
│ ├── ai-service/ # AI能力服务
│ └── user-center-service/ # 用户中心服务
├── database/ # 数据库脚本和设计
── utils/ # 工具函数和公共模块
├── common/ # 公共模块
── docs/ # 后端文档
├── scripts/ # 后端脚本
└── pom.xml # Maven父项目配置文件
```
#### 微服务模块结构
每个微服务模块都遵循标准的Maven项目结构
```
{service-name}/
├── src/
│ ├── main/
│ │ ├── java/com/xlxumu/{service}/
│ │ └── resources/
│ └── test/
│ └── java/com/xlxumu/{service}/
└── pom.xml
```
### 2. 管理后台系统目录 (admin-system/)
@@ -141,7 +151,7 @@ scripts/
## 目录命名规范
1. **后端目录**: 使用英文单数形式,如 `backend/`
1. **后端目录**: 使用英文单数形式,如 `backend-java/`
2. **前端目录**: 使用英文单数形式,如 `admin-system/`
3. **文档目录**: 使用英文复数形式,如 `docs/`
4. **子目录**: 使用英文连字符分隔,如 `farming-management/`

View File

@@ -47,9 +47,9 @@
- [普通用户小程序API](./design/api/miniprograms/user-app.md) - 普通用户小程序相关接口
### 4. 技术文档
- 数据库设计文档 (位于[backend/database](file:///E:/vue/xlxumu/backend/database)目录)
- 数据库设计文档 (位于[backend-java/services/farming-service/src/main/resources/sql](file:///Users/ainongkeji/code/vue/xlxumu/backend-java/services/farming-service/src/main/resources/sql)目录)
- 前端组件文档 (各前端项目中)
- 部署文档 ([deployment/README.md](file:///E:/vue/xlxumu/deployment/README.md))
- 部署文档 ([deployment/README.md](file:///Users/ainongkeji/code/vue/xlxumu/deployment/README.md))
### 5. 各系统详细开发计划
- [养殖管理系统开发计划](./development_plans/farming_management_development_plan.md) - 养殖管理系统的详细开发计划

View File

@@ -329,38 +329,41 @@
```
.
├── frontend/ # 前端项目
│ ├── website/ # 官网首页
├── admin-system/ # 管理系统
│ ├── dashboard/ # 数据大屏
│ ├── official-website/ # 官网
│ ├── 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/ # 后端项目
│ ├── api/ # API服务
│ ├── farming/ # 养殖管理API
│ ├── finance/ # 金融服务API
│ │ ├── government/ # 政府监管API
│ │ ├── trade/ # 交易管理API
│ │ ├── mall/ # 商城管理API
│ │ ├── data-platform/ # 数据中台API
│ │ ├── ai/ # AI能力API
│ │ ├── website/ # 官网API
│ │ ── user-center/ # 用户中心API
├── database/ # 数据库脚本
│ ├── utils/ # 工具函数
── services/ # 微服务模块
── mall-management/ # 商城管理系统
├── mini_program/ # 小程序集合
── farming-manager/ # 养殖管理小程序
│ ├── beef-mall/ # 牛肉商城小程序
├── bank-supervision/ # 银行监管小程序
├── insurance-supervision/ # 保险监管小程序
├── cattle-trading/ # 活牛交易小程序
└── government-supervision/ # 政府监管小程序
├── website/ # 官方网站
├── backend-java/ # 后端项目 (Java微服务架构)
├── api/ # API网关模块
│ ├── gateway/ # Spring Cloud Gateway网关服务
│ ├── registry/ # Eureka服务注册中心
│ ├── config-server/ # Spring Cloud配置中心
│ ├── services/ # 微服务模块
│ │ ├── farming-service/ # 养殖管理服务
│ │ ├── finance-service/ # 金融服务
│ │ ├── government-service/ # 政府监管服务
│ │ ├── trade-service/ # 交易管理服务
│ │ ├── mall-service/ # 商城管理服务
│ │ ├── data-platform-service/ # 数据中台服务
│ │ ── ai-service/ # AI能力服务
│ └── user-center-service/ # 用户中心服务
│ ├── common/ # 公共模块
── docs/ # 后端文档
│ ├── scripts/ # 后端脚本
│ └── pom.xml # Maven父项目配置文件
├── docs/ # 文档
└── deployment/ # 部署相关配置
```