205 lines
7.0 KiB
Markdown
205 lines
7.0 KiB
Markdown
# 畜牧养殖管理平台
|
||
|
||
## 项目概述
|
||
|
||
畜牧养殖管理平台是一个综合性的数字化养殖管理解决方案，旨在通过现代化的信息技术手段，为养殖户、管理机构、金融机构等提供全方位的养殖管理服务。
|
||
|
||
### 核心功能
|
||
|
||
- **养殖管理**：动物档案管理、健康监控、饲料管理、疫苗接种记录
|
||
- **交易平台**：牲畜交易、价格监控、订单管理、物流跟踪
|
||
- **金融服务**：保险管理、贷款申请、风险评估、资金监管
|
||
- **数据分析**：养殖数据统计、市场分析、趋势预测、决策支持
|
||
- **政府监管**：养殖场备案、疫情监控、食品安全追溯、政策发布
|
||
|
||
### 技术架构
|
||
|
||
- **前端技术**：Vue.js 3 + Element Plus + Vite
|
||
- **小程序**：微信小程序原生开发
|
||
- **后端技术**：Node.js + Express / Python + FastAPI
|
||
- **数据库**：MySQL + Redis + MongoDB
|
||
- **部署方案**：Docker + Nginx + 云服务器
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
xlxumu/
|
||
├── README.md # 项目入口文档
|
||
├── docs/ # 文档目录
|
||
│ ├── requirements/ # 需求文档
|
||
│ ├── architecture/ # 架构文档
|
||
│ ├── design/ # 详细设计文档
|
||
│ ├── development/ # 开发文档
|
||
│ └── operations/ # 运维文档
|
||
├── admin-system/ # 管理后台系统
|
||
│ ├── dashboard/ # 数据看板
|
||
│ ├── farming-management/ # 养殖管理
|
||
│ ├── cattle-trading/ # 牲畜交易
|
||
│ ├── bank-supervision/ # 银行监管
|
||
│ ├── insurance-supervision/ # 保险监管
|
||
│ ├── government-platform/ # 政府平台
|
||
│ └── mall-management/ # 商城管理
|
||
├── mini_program/ # 小程序应用
|
||
│ ├── farming-manager/ # 养殖管理小程序
|
||
│ ├── cattle-trading/ # 交易平台小程序
|
||
│ ├── beef-mall/ # 牛肉商城小程序
|
||
│ ├── bank-supervision/ # 银行监管小程序
|
||
│ └── insurance-supervision/ # 保险监管小程序
|
||
├── backend/ # 后端服务
|
||
│ ├── api/ # API服务
|
||
│ ├── database/ # 数据库管理
|
||
│ ├── services/ # 业务服务
|
||
│ └── utils/ # 工具类
|
||
├── website/ # 官方网站
|
||
├── scripts/ # 脚本工具
|
||
└── deployment/ # 部署配置
|
||
```
|
||
|
||
## 快速开始
|
||
|
||
### 环境要求
|
||
|
||
- Node.js 16+
|
||
- Python 3.9+
|
||
- MySQL 8.0+
|
||
- Redis 6.0+
|
||
- Docker & Docker Compose
|
||
|
||
### 安装步骤
|
||
|
||
1. **克隆项目**
|
||
```bash
|
||
git clone https://github.com/your-org/xlxumu.git
|
||
cd xlxumu
|
||
```
|
||
|
||
2. **安装依赖**
|
||
```bash
|
||
# 安装前端依赖
|
||
cd admin-system/dashboard
|
||
npm install
|
||
|
||
# 安装后端依赖
|
||
cd ../../backend/api
|
||
npm install
|
||
```
|
||
|
||
3. **配置环境**
|
||
```bash
|
||
# 复制环境配置文件
|
||
cp backend/api/.env.example backend/api/.env
|
||
# 编辑配置文件，填入数据库等配置信息
|
||
```
|
||
|
||
4. **初始化数据库**
|
||
```bash
|
||
cd backend/database
|
||
npm run setup
|
||
```
|
||
|
||
5. **启动服务**
|
||
```bash
|
||
# 启动后端服务
|
||
cd backend/api
|
||
npm run dev
|
||
|
||
# 启动前端服务
|
||
cd admin-system/dashboard
|
||
npm run dev
|
||
```
|
||
|
||
### Docker 部署
|
||
|
||
```bash
|
||
# 使用 Docker Compose 一键启动
|
||
docker-compose up -d
|
||
|
||
# 查看服务状态
|
||
docker-compose ps
|
||
```
|
||
|
||
## 文档导航
|
||
|
||
### 📋 需求文档
|
||
- [整个项目需求文档](docs/requirements/整个项目需求文档.md) - 项目整体需求概述
|
||
- [官网需求文档](docs/requirements/官网需求文档.md) - 官方网站功能需求
|
||
- [后端管理需求文档](docs/requirements/后端管理需求文档.md) - 后端管理系统需求
|
||
- [管理后台需求文档](docs/requirements/管理后台需求文档.md) - 管理后台功能需求
|
||
- [小程序app需求文档](docs/requirements/小程序app需求文档.md) - 小程序应用需求
|
||
|
||
### 🏗️ 架构文档
|
||
- [整个项目的架构文档](docs/architecture/整个项目的架构文档.md) - 系统整体架构设计
|
||
- [后端架构文档](docs/architecture/后端架构文档.md) - 后端服务架构
|
||
- [小程序架构文档](docs/architecture/小程序架构文档.md) - 小程序技术架构
|
||
- [管理后台架构文档](docs/architecture/管理后台架构文档.md) - 管理后台架构
|
||
|
||
### 📐 详细设计文档
|
||
- [数据库设计文档](docs/design/数据库设计文档.md) - 数据库表结构设计
|
||
- [管理后台接口设计文档](docs/design/管理后台接口设计文档.md) - 管理后台API设计
|
||
- [小程序app接口设计文档](docs/design/小程序app接口设计文档.md) - 小程序API设计
|
||
|
||
### 👨💻 开发文档
|
||
- [后端开发文档](docs/development/后端开发文档.md) - 后端开发指南
|
||
- [后端管理开发文档](docs/development/后端管理开发文档.md) - 后端管理系统开发
|
||
- [小程序app开发文档](docs/development/小程序app开发文档.md) - 小程序开发指南
|
||
- [管理后台开发文档](docs/development/管理后台开发文档.md) - 管理后台开发指南
|
||
|
||
### 🛠️ 运维文档
|
||
- [测试文档](docs/operations/测试文档.md) - 测试策略和用例
|
||
- [部署文档](docs/operations/部署文档.md) - 部署指南和配置
|
||
- [运维文档](docs/operations/运维文档.md) - 运维操作和监控
|
||
- [安全文档](docs/operations/安全文档.md) - 安全策略和防护
|
||
- [用户手册文档](docs/operations/用户手册文档.md) - 用户操作指南
|
||
|
||
## 开发团队
|
||
|
||
### 项目角色分工
|
||
|
||
- **项目经理**：项目整体规划和进度管控
|
||
- **产品经理**：需求分析和产品设计
|
||
- **架构师**：系统架构设计和技术选型
|
||
- **前端开发**：管理后台和官网开发
|
||
- **小程序开发**：微信小程序开发
|
||
- **后端开发**：API服务和数据库设计
|
||
- **测试工程师**：功能测试和性能测试
|
||
- **运维工程师**：部署和运维管理
|
||
|
||
### 开发规范
|
||
|
||
- **代码规范**：遵循ESLint和Prettier配置
|
||
- **Git规范**：使用Git Flow工作流
|
||
- **API规范**：遵循RESTful设计原则
|
||
- **文档规范**：使用Markdown格式编写
|
||
|
||
## 部署环境
|
||
|
||
### 开发环境
|
||
- **地址**：http://dev.xlxumu.com
|
||
- **数据库**：开发环境数据库
|
||
- **用途**：日常开发和功能测试
|
||
|
||
### 测试环境
|
||
- **地址**：http://test.xlxumu.com
|
||
- **数据库**：测试环境数据库
|
||
- **用途**：集成测试和用户验收测试
|
||
|
||
### 生产环境
|
||
- **地址**：https://www.xlxumu.com
|
||
- **数据库**：生产环境数据库
|
||
- **用途**：正式运营环境
|
||
|
||
## 联系方式
|
||
|
||
- **项目仓库**：https://github.com/your-org/xlxumu
|
||
- **问题反馈**：https://github.com/your-org/xlxumu/issues
|
||
- **技术支持**：tech-support@xlxumu.com
|
||
- **商务合作**：business@xlxumu.com
|
||
|
||
## 许可证
|
||
|
||
本项目采用 [MIT License](LICENSE) 开源协议。
|
||
|
||
---
|
||
|
||
**最后更新**：2024年12月
|
||
**文档版本**：v1.0.0 |