aiotagro/xlxumu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: 重构数据库配置为SQLite开发环境并移除冗余文档

Browse Source
This commit is contained in:
aiotagro
2025-09-21 15:16:48 +08:00
parent d207610009
commit 3c8648a635
259 changed files with 88239 additions and 8379 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
docs/README.md
View File

@@ -1,126 +1,142 @@
# xlxumu项目文档
# 智慧畜牧业小程序矩阵 - 文档中心
## 项目概述
欢迎来到智慧畜牧业小程序矩阵的文档中心！这里包含了项目的完整文档资料。
xlxumu是一个综合性的畜牧管理系统，旨在为畜牧业提供全面的数字化解决方案。该系统涵盖了从养殖管理、金融服务、政府监管到电商交易等各个环节，通过现代化的技术架构和用户友好的界面设计，提升畜牧业的管理效率和经济效益。
## 📚 文档目录
## 文档结构
### 📋 需求文档
- [整个项目需求文档](requirements/整个项目需求文档.md) - 项目整体需求说明
- [官网需求文档](requirements/官网需求文档.md) - 官方网站需求
- [后端管理需求文档](requirements/后端管理需求文档.md) - 后端管理系统需求
- [管理后台需求文档](requirements/管理后台需求文档.md) - 管理后台需求
- [小程序app需求文档](requirements/小程序app需求文档.md) - 小程序应用需求
### 🏗️ 架构文档
- [整个项目的架构文档](architecture/整个项目的架构文档.md) - 项目整体架构设计
- [后端架构文档](architecture/后端架构文档.md) - 后端系统架构
- [小程序架构文档](architecture/小程序架构文档.md) - 小程序架构设计
- [管理后台架构文档](architecture/管理后台架构文档.md) - 管理后台架构
### 🎨 设计文档
- [数据库设计文档](design/database/数据库设计文档.md) - 数据库结构设计
- [管理后台接口设计文档](design/api/管理后台接口设计文档.md) - 管理后台API设计
- [小程序app接口设计文档](design/api/小程序app接口设计文档.md) - 小程序API设计
### 💻 开发文档
- [后端开发文档](development/后端开发文档.md) - 后端开发指南
- [小程序app开发文档](development/小程序app开发文档.md) - 小程序开发指南
- [管理后台开发文档](development/管理后台开发文档.md) - 管理后台开发指南
- [后端管理开发文档](development/后端管理开发文档.md) - 后端管理开发指南
- [小程序开发技术文档](development/小程序开发技术文档.md) - 小程序技术详细文档
- [小程序开发完成总结-最终版](development/小程序开发完成总结-最终版.md) - 开发完成总结
### 🔧 运维文档
- [测试文档](operations/测试文档.md) - 测试规范和流程
- [部署文档](operations/部署文档.md) - 部署指南
- [运维文档](operations/运维文档.md) - 运维管理
- [安全文档](operations/安全文档.md) - 安全规范
### 📖 用户文档
- [用户手册文档](operations/用户手册文档.md) - 用户使用指南
## 🚀 快速开始
### 新手指南
1. 首先阅读 [整个项目需求文档](requirements/整个项目需求文档.md) 了解项目背景
2. 查看 [整个项目的架构文档](architecture/整个项目的架构文档.md) 理解系统架构
3. 根据你的角色选择相应的开发文档：
- 小程序开发：[小程序开发技术文档](development/小程序开发技术文档.md)
- 后端开发：[后端开发文档](development/后端开发文档.md)
- 前端开发：[管理后台开发文档](development/管理后台开发文档.md)
### 开发者路径
```
docs/
├── requirements/ # 需求文档
├── design/ # 设计文档
├── development_plans/ # 开发计划
├── API_DOCUMENTATION_STANDARD.md # API文档标准
├── API_DOCUMENTATION_CHECKLIST.md # API文档检查清单
├── DOCUMENTATION_MAINTENANCE_PROCESS.md # 文档维护流程
├── PROJECT_STRUCTURE.md # 项目结构说明
└── README.md # 文档目录说明（当前文件）
项目需求 → 架构设计 → 接口设计 → 开发实现 → 测试部署
↓ ↓ ↓ ↓ ↓
需求文档 架构文档 设计文档 开发文档 运维文档
```
## 需求文档 (requirements/)
## 📋 文档规范
### 系统级需求
- [SYSTEM_REQUIREMENTS.md](requirements/SYSTEM_REQUIREMENTS.md) - 系统整体需求
- [SYSTEM_INTEGRATION_REQUIREMENTS.md](requirements/SYSTEM_INTEGRATION_REQUIREMENTS.md) - 系统集成需求
### 文档格式
- 所有文档使用 Markdown 格式编写
- 文件名使用中文，便于理解
- 文档结构清晰，层次分明
- 包含目录导航和交叉引用
### 业务模块需求
- [FARMING_MANAGEMENT_REQUIREMENTS.md](requirements/FARMING_MANAGEMENT_REQUIREMENTS.md) - 养殖管理需求
- [FINANCIAL_SERVICES_REQUIREMENTS.md](requirements/FINANCIAL_SERVICES_REQUIREMENTS.md) - 金融服务需求
- [GOVERNMENT_SUPERVISION_REQUIREMENTS.md](requirements/GOVERNMENT_SUPERVISION_REQUIREMENTS.md) - 政府监管需求
- [MARKET_TRADING_REQUIREMENTS.md](requirements/MARKET_TRADING_REQUIREMENTS.md) - 市场交易需求
- [MALL_MANAGEMENT_REQUIREMENTS.md](requirements/MALL_MANAGEMENT_REQUIREMENTS.md) - 商城管理需求
- [DATA_PLATFORM_REQUIREMENTS.md](requirements/DATA_PLATFORM_REQUIREMENTS.md) - 数据平台需求
- [AI_CAPABILITIES_REQUIREMENTS.md](requirements/AI_CAPABILITIES_REQUIREMENTS.md) - AI能力需求
- [WEBSITE_REQUIREMENTS.md](requirements/WEBSITE_REQUIREMENTS.md) - 官网需求
- [RAISING_MANAGEMENT_REQUIREMENTS.md](requirements/RAISING_MANAGEMENT_REQUIREMENTS.md) - 养殖管理需求
### 文档维护
- 文档与代码同步更新
- 重要变更及时更新相关文档
- 定期审查文档的准确性和完整性
- 欢迎提交文档改进建议
### 小程序需求
- [farming_app_requirements.md](requirements/farming_app_requirements.md) - 养殖管理小程序需求
- [finance_app_requirements.md](requirements/finance_app_requirements.md) - 金融小程序需求
- [gov_app_requirements.md](requirements/gov_app_requirements.md) - 政府监管小程序需求
- [trading_app_requirements.md](requirements/trading_app_requirements.md) - 交易小程序需求
- [mall_app_requirements.md](requirements/mall_app_requirements.md) - 商城小程序需求
- [data_platform_app_requirements.md](requirements/data_platform_app_requirements.md) - 数据平台小程序需求
- [ai_app_requirements.md](requirements/ai_app_requirements.md) - AI能力小程序需求
- [dashboard_requirements.md](requirements/dashboard_requirements.md) - 仪表板需求
## 🔍 文档搜索
## 设计文档 (design/)
### 按主题查找
- **需求相关**: requirements/ 目录
- **架构设计**: architecture/ 目录
- **详细设计**: design/ 目录
- **开发指南**: development/ 目录
- **运维部署**: operations/ 目录
### 系统架构设计
- [ARCHITECTURE.md](design/ARCHITECTURE.md) - 系统架构设计
- [system_architecture.svg](design/system_architecture.svg) - 系统架构图
### 按角色查找
- **产品经理**: 需求文档、架构文档
- **架构师**: 架构文档、设计文档
- **后端开发**: 后端相关开发文档、API设计
- **前端开发**: 小程序开发文档、管理后台开发文档
- **测试工程师**: 测试文档、部署文档
- **运维工程师**: 部署文档、运维文档、安全文档
- **项目经理**: 所有文档概览
### 数据库设计
- [database/README.md](design/database/README.md) - 数据库设计说明
- [database/DESIGN.md](design/database/DESIGN.md) - 数据库详细设计
## 📞 获取帮助
### API设计
- [api/farming.md](design/api/farming.md) - 养殖管理API设计
- [api/finance.md](design/api/finance.md) - 金融服务API设计
- [api/government.md](design/api/government.md) - 政府监管API设计
- [api/trade.md](design/api/trade.md) - 交易管理API设计
- [api/data-platform.md](design/api/data-platform.md) - 数据平台API设计
- [api/user-center.md](design/api/user-center.md) - 用户中心API设计
- [api/dashboard.md](design/api/dashboard.md) - 仪表板API设计
- [api/website.md](design/api/website.md) - 官网API设计
### 文档问题
如果您在阅读文档时遇到问题：
1. 检查是否有相关的交叉引用
2. 查看文档更新日期，确保信息是最新的
3. 在项目仓库提交 Issue
4. 联系文档维护团队
### 小程序API设计
- [api/miniprograms/](design/api/miniprograms/) - 小程序API设计目录
### 联系方式
- 📧 邮箱：docs@xlxumu.com
- 💬 项目讨论：GitHub Issues
- 📱 技术支持：dev@xlxumu.com
## 开发计划 (development_plans/)
## 🤝 贡献文档
### 后端开发计划
- [backend_api_development_plan.md](development_plans/backend_api_development_plan.md) - 后端API开发计划
我们欢迎您为文档做出贡献：
### 前端开发计划
- [dashboard_development_plan.md](development_plans/dashboard_development_plan.md) - 仪表板开发计划
- [farming_management_development_plan.md](development_plans/farming_management_development_plan.md) - 养殖管理开发计划
- [cattle_trading_development_plan.md](development_plans/cattle_trading_development_plan.md) - 牛只交易开发计划
- [mall_management_development_plan.md](development_plans/mall_management_development_plan.md) - 商城管理开发计划
- [bank_supervision_development_plan.md](development_plans/bank_supervision_development_plan.md) - 银行监管开发计划
- [insurance_supervision_development_plan.md](development_plans/insurance_supervision_development_plan.md) - 保险监管开发计划
- [government_platform_development_plan.md](development_plans/government_platform_development_plan.md) - 政府平台开发计划
- [website_development_plan.md](development_plans/website_development_plan.md) - 官网开发计划
### 如何贡献
1. Fork 项目仓库
2. 在 `docs/` 目录下编辑或添加文档
3. 确保文档格式正确，内容准确
4. 提交 Pull Request
5. 等待审核和合并
### 小程序开发计划
- [farming_management_miniprogram_development_plan.md](development_plans/farming_management_miniprogram_development_plan.md) - 养殖管理小程序开发计划
- [cattle_trading_miniprogram_development_plan.md](development_plans/cattle_trading_miniprogram_development_plan.md) - 牛只交易小程序开发计划
- [beef_mall_miniprogram_development_plan.md](development_plans/beef_mall_miniprogram_development_plan.md) - 牛肉商城小程序开发计划
- [bank_supervision_miniprogram_development_plan.md](development_plans/bank_supervision_miniprogram_development_plan.md) - 银行监管小程序开发计划
- [insurance_supervision_miniprogram_development_plan.md](development_plans/insurance_supervision_miniprogram_development_plan.md) - 保险监管小程序开发计划
### 贡献指南
- 遵循现有的文档结构和格式
- 使用清晰、简洁的语言
- 提供必要的示例和图表
- 确保链接和引用的准确性
## 标准与规范
## 📈 文档统计
- [API_DOCUMENTATION_STANDARD.md](API_DOCUMENTATION_STANDARD.md) - API文档标准
- [API_DOCUMENTATION_CHECKLIST.md](API_DOCUMENTATION_CHECKLIST.md) - API文档检查清单
- [DOCUMENTATION_MAINTENANCE_PROCESS.md](DOCUMENTATION_MAINTENANCE_PROCESS.md) - 文档维护流程
- [PROJECT_STRUCTURE.md](PROJECT_STRUCTURE.md) - 项目结构说明
| 文档类型 | 数量 | 状态 |
|---------|------|------|
| 需求文档 | 5 | ✅ 完成 |
| 架构文档 | 4 | ✅ 完成 |
| 设计文档 | 3 | ✅ 完成 |
| 开发文档 | 6 | ✅ 完成 |
| 运维文档 | 5 | ✅ 完成 |
| **总计** | **23** | **✅ 完成** |
## 技术架构更新
## 📅 更新记录
随着项目的发展，我们新增了Java版本后端技术栈：
- **2024-01-20**: 完成所有基础文档的创建
- **2024-01-15**: 添加小程序开发技术文档
- **2024-01-10**: 完善架构设计文档
- **2024-01-05**: 初始化文档结构
### Java后端技术栈
- Java 8+ + Spring Boot 2.7.x
- Spring Cloud 2021.x
- Maven 3.8.x
- MySQL 8.0
---
### 微服务架构
项目现在采用微服务架构，包含以下服务：
- farming-service (养殖管理服务)
- user-center-service (用户中心服务)
- finance-service (金融服务)
- government-service (政府监管服务)
- trade-service (交易管理服务)
- mall-service (商城管理服务)
- data-platform-service (数据平台服务)
- ai-service (AI能力服务)
- gateway (网关服务)
- config-server (配置服务器)
- registry (服务注册中心)
## 文档维护
请参考 [DOCUMENTATION_MAINTENANCE_PROCESS.md](DOCUMENTATION_MAINTENANCE_PROCESS.md) 了解文档维护流程和规范。
*本文档中心持续更新中，感谢您的关注和支持！* 📚✨