docs: 重构API文档和系统架构文档,统一技术栈规范docs(architecture): 更新系统架构设计文档
- 重新组织文档结构,优化标题层级 - 添加系统架构图,直观展示系统组成- 补充前端架构、后端架构、数据架构等详细内容 - 更新安全架构、部署架构、性能优化策略等章节 - 增加扩展性设计和高可用设计章节 - 总结系统架构设计特点和优势
This commit is contained in:
180
README.md
180
README.md
@@ -1,105 +1,117 @@
|
||||
# xlxumu - 锡林郭勒盟地区智慧养殖产业平台
|
||||
# xlxumu - 畜牧管理系统
|
||||
|
||||
## 项目概述
|
||||
|
||||
本项目是一个综合性的畜牧业数字化管理平台,主要面向锡林郭勒盟地区的养殖产业,包含官网展示、后台管理、移动端小程序、大屏可视化等多个子系统。平台集成了养殖管理、金融服务(银行监管、保险监管)、政府监管、牛只交易、牛肉商城、数据分析等功能模块,旨在通过数字化手段提升整个产业链的管理效率和透明度。
|
||||
xlxumu是一个综合性的畜牧管理系统,旨在为畜牧业提供全面的数字化解决方案。该系统涵盖了从养殖管理、金融服务、政府监管到电商交易等各个环节,通过现代化的技术架构和用户友好的界面设计,提升畜牧业的管理效率和经济效益。
|
||||
|
||||
## 技术架构
|
||||
|
||||
项目采用前后端分离的架构设计,包含多个技术栈:
|
||||
|
||||
### 前端技术栈
|
||||
|
||||
1. **管理后台系统** (admin-system)
|
||||
- React + Vite
|
||||
- Ant Design Pro
|
||||
- TypeScript
|
||||
|
||||
2. **小程序端** (mini_program)
|
||||
- 微信小程序原生开发
|
||||
- WXML + WXSS + JavaScript
|
||||
|
||||
3. **官网** (website)
|
||||
- HTML5 + CSS3 + JavaScript
|
||||
|
||||
### 后端技术栈
|
||||
|
||||
1. **Node.js版本** (backend)
|
||||
- Node.js + Express
|
||||
- MySQL
|
||||
|
||||
2. **Java版本** (backend-java)
|
||||
- Java 8+ + Spring Boot 2.7.x
|
||||
- Spring Cloud 2021.x
|
||||
- MySQL 8.0
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
.
|
||||
├── backend-java/ # 后端Java微服务项目
|
||||
│ ├── api/ # API网关
|
||||
│ ├── gateway/ # 网关服务
|
||||
│ ├── registry/ # 服务注册与发现
|
||||
│ ├── config-server/ # 配置中心
|
||||
│ ├── services/ # 业务服务模块
|
||||
│ │ ├── farming-service/ # 养殖管理服务
|
||||
│ │ ├── finance-service/ # 金融服务
|
||||
│ │ ├── government-service/ # 政府监管服务
|
||||
│ │ ├── trade-service/ # 交易管理服务
|
||||
│ │ ├── mall-service/ # 商城管理服务
|
||||
│ │ ├── data-platform-service/ # 数据中台服务
|
||||
│ │ ├── ai-service/ # AI能力服务
|
||||
│ │ └── user-center-service/ # 用户中心服务
|
||||
│ ├── common/ # 公共模块
|
||||
│ ├── docs/ # 文档
|
||||
│ └── scripts/ # 脚本
|
||||
├── admin-system/ # 管理后台系统
|
||||
│ ├── farming-management/ # 养殖管理系统
|
||||
│ ├── bank-supervision/ # 银行监管系统
|
||||
│ ├── insurance-supervision/ # 保险监管系统
|
||||
│ ├── government-platform/ # 政府监管平台
|
||||
│ ├── cattle-trading/ # 活牛交易系统
|
||||
│ ├── mall-management/ # 商城管理系统
|
||||
│ └── dashboard/ # 大屏可视化系统
|
||||
├── website/ # 官网项目
|
||||
├── mini_program/ # 微信小程序矩阵
|
||||
│ ├── beef-mall/ # 牛肉商城小程序
|
||||
│ ├── farming-manager/ # 养殖管理小程序
|
||||
xlxumu/
|
||||
├── admin-system/ # 管理后台系统
|
||||
│ ├── bank-supervision/ # 银行监管子系统
|
||||
│ ├── cattle-trading/ # 牛只交易子系统
|
||||
│ ├── dashboard/ # 仪表板子系统
|
||||
│ ├── farming-management/ # 养殖管理子系统
|
||||
│ ├── government-platform/ # 政府平台子系统
|
||||
│ ├── insurance-supervision/ # 保险监管子系统
|
||||
│ └── mall-management/ # 商城管理子系统
|
||||
├── backend/ # Node.js后端服务
|
||||
├── backend-java/ # Java后端服务
|
||||
├── mini_program/ # 微信小程序
|
||||
│ ├── bank-supervision/ # 银行监管小程序
|
||||
│ ├── insurance-supervision/ # 保险监管小程序
|
||||
│ ├── cattle-trading/ # 活牛交易小程序
|
||||
│ ├── gov-supervision/ # 政府监管小程序
|
||||
│ ├── data-platform/ # 数据中台小程序
|
||||
│ └── ai-capabilities/ # AI能力小程序
|
||||
├── docs/ # 文档目录
|
||||
│ ├── design/ # 设计文档
|
||||
│ ├── requirements/ # 需求文档
|
||||
│ └── development_plans/ # 开发计划文档
|
||||
├── test/ # 测试文件目录
|
||||
└── deployment/ # 部署相关配置
|
||||
│ ├── beef-mall/ # 牛肉商城小程序
|
||||
│ ├── cattle-trading/ # 牛只交易小程序
|
||||
│ ├── farming-manager/ # 养殖管理小程序
|
||||
│ └── insurance-supervision/ # 保险监管小程序
|
||||
├── website/ # 官网
|
||||
└── docs/ # 项目文档
|
||||
```
|
||||
|
||||
## 文档目录
|
||||
## 快速开始
|
||||
|
||||
详细文档请参见 [docs/README.md](docs/README.md) 文件,其中包含所有系统文档的完整列表和链接。
|
||||
### 前端项目启动
|
||||
|
||||
- `docs/requirements/` - 需求文档
|
||||
- `docs/design/` - 设计文档
|
||||
- `docs/development_plans/` - 开发计划
|
||||
- `docs/PROJECT_STRUCTURE.md` - 项目结构说明文档
|
||||
1. **管理后台系统**
|
||||
```bash
|
||||
cd admin-system/dashboard
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 技术栈
|
||||
2. **微信小程序**
|
||||
使用微信开发者工具打开对应的小程序目录
|
||||
|
||||
### 技术栈
|
||||
- **官网项目 (website/)**: HTML5 + CSS3 + JavaScript
|
||||
- **管理后台系统 (admin-system/)**: Vue.js 3 + TypeScript + Ant Design Vue + Pinia
|
||||
- **微信小程序矩阵 (mini_program/)**: 微信小程序原生开发 + uni-app
|
||||
3. **官网**
|
||||
直接在浏览器中打开website/index.html文件
|
||||
|
||||
### 后端技术栈
|
||||
- **核心框架**: Spring Boot 2.7.5 + Spring Cloud 2021.0.5
|
||||
- **编程语言**: Java 11
|
||||
- **构建工具**: Maven 3.8+
|
||||
- **数据库**: MySQL 8.0
|
||||
- **缓存系统**: Redis
|
||||
- **消息队列**: RabbitMQ
|
||||
- **API文档**: Swagger/OpenAPI 3.0
|
||||
- **监控**: Spring Boot Admin + Micrometer
|
||||
- **安全**: Spring Security + OAuth2 + JWT
|
||||
- **配置中心**: Spring Cloud Config
|
||||
- **服务发现**: Spring Cloud Eureka
|
||||
- **负载均衡**: Spring Cloud LoadBalancer
|
||||
- **熔断器**: Resilience4j
|
||||
- **链路追踪**: Spring Cloud Sleuth + Zipkin
|
||||
- **容器化**: Docker
|
||||
- **编排**: Kubernetes
|
||||
### 后端服务启动
|
||||
|
||||
## 部署说明
|
||||
#### Node.js版本
|
||||
```bash
|
||||
cd backend
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
详细的部署说明请参考 [deployment/README.md](deployment/README.md) 文件。
|
||||
#### Java版本
|
||||
```bash
|
||||
cd backend-java
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
## 开发说明
|
||||
然后分别启动各个微服务:
|
||||
```bash
|
||||
# 启动farming-service
|
||||
cd backend-java/services/farming-service
|
||||
mvn spring-boot:run
|
||||
|
||||
1. 管理后台系统 (admin-system/) 使用 Vite 构建
|
||||
2. 后端项目 (backend-java/) 基于 Java 11 和 Spring Boot 2.7.5
|
||||
3. 各个子系统可以独立开发和部署
|
||||
4. 微服务架构便于扩展和维护
|
||||
# 启动user-center-service
|
||||
cd backend-java/services/user-center-service
|
||||
mvn spring-boot:run
|
||||
```
|
||||
|
||||
## 项目特点
|
||||
## 文档
|
||||
|
||||
1. **模块化设计**: 前后端分离,模块化设计便于团队协作
|
||||
2. **微服务架构**: 后端采用微服务架构,提高系统可扩展性
|
||||
3. **多端支持**: 支持PC端、移动端、微信小程序和大屏展示
|
||||
4. **数据驱动**: 集成数据分析和可视化展示
|
||||
5. **安全可靠**: 完善的权限管理和数据安全保障
|
||||
详细的项目文档位于`docs/`目录下,包括:
|
||||
- 需求文档
|
||||
- 设计文档
|
||||
- API文档
|
||||
- 开发计划
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎提交Issue和Pull Request来改进本项目。
|
||||
|
||||
## 许可证
|
||||
|
||||
[MIT License](LICENSE)
|
||||
Reference in New Issue
Block a user