Files
nxxmdata/README.md

226 lines
6.5 KiB
Markdown
Raw Normal View History

2025-09-19 23:46:15 +08:00
# 宁夏智慧养殖监管平台
<div align="center">
![项目版本](https://img.shields.io/badge/版本-v2.2.0-blue.svg)
![Node.js版本](https://img.shields.io/badge/Node.js-16.20.2-green.svg)
![Vue版本](https://img.shields.io/badge/Vue-3.4.15-brightgreen.svg)
![许可证](https://img.shields.io/badge/许可证-MIT-yellow.svg)
**现代化的智慧养殖监管平台集成IoT设备监控、动物健康管理、数据可视化分析等功能**
[功能特性](#功能特性) • [快速开始](#快速开始) • [项目架构](#项目架构) • [文档](#文档) • [贡献指南](#贡献指南)
</div>
## 📋 项目概述
宁夏智慧养殖监管平台是一个现代化的农场管理系统,旨在通过数字化手段提升养殖业的管理效率和监管水平。系统采用前后端分离架构,支持多端访问,为养殖场管理者、监管部门和相关机构提供全方位的智慧养殖解决方案。
### 🎯 核心价值
- **智能监控**:实时监控养殖环境和设备状态
- **数据驱动**:基于大数据分析的决策支持
- **全程追溯**:完整的养殖过程记录和追溯
- **多端协同**支持Web端、小程序等多平台访问
- **安全可靠**:企业级安全防护和数据保护
## ✨ 功能特性
### 🏭 核心业务模块
- **🏢 养殖场管理**:养殖场信息、圈舍管理、电子围栏
- **🐄 动物健康管理**:牲畜档案、健康监测、批次管理
- **📱 IoT设备监控**:传感器数据、设备状态、实时告警
- **📊 数据可视化**:统计分析、图表展示、决策支持
- **👥 用户权限管理**:多角色权限、操作审计、安全控制
- **🛒 产品订单管理**:产品销售、订单处理、库存管理
- **⚠️ 预警管理**:智能告警、异常处理、风险预防
### 🌐 多端支持
- **管理后台**基于Vue 3的现代化管理界面
- **数据大屏**:实时数据展示和监控大屏
- **官方网站**:产品展示和信息发布
- **小程序矩阵**
- 银行端小程序:金融服务支持
- 政府端小程序:监管和政策发布
- 保险端小程序:保险服务管理
### 🛠️ 技术特性
- **现代化技术栈**Vue 3 + Node.js + MySQL
- **响应式设计**:适配多种设备和屏幕尺寸
- **实时通信**WebSocket支持实时数据推送
- **地图集成**百度地图API地理信息展示
- **性能监控**:完整的系统性能监控体系
- **API文档**Swagger自动生成API文档
## 🚀 快速开始
### 环境要求
- **Node.js**: 16.20.2+
- **MySQL**: 8.0+
- **npm**: 8.0.0+
### 安装步骤
1. **克隆项目**
```bash
git clone <repository-url>
cd nxxmdata
```
2. **安装依赖**
```bash
# 安装后端依赖
cd backend
npm install
# 安装前端依赖
cd ../admin-system
npm install
# 安装数据大屏依赖
cd ../datav
npm install
```
3. **配置环境**
```bash
# 复制环境配置文件
cp backend/.env.example backend/.env
cp admin-system/.env.example admin-system/.env
# 编辑配置文件,设置数据库连接等信息
```
4. **初始化数据库**
```bash
cd backend
npm run init-db
```
5. **启动服务**
```bash
# 启动后端服务 (端口: 5000)
cd backend
npm run dev
# 启动管理后台 (端口: 5173)
cd admin-system
npm run dev
# 启动数据大屏 (端口: 5174)
cd datav
npm run dev
```
### 访问地址
- **管理后台**: http://localhost:5173
- **数据大屏**: http://localhost:5174
- **API文档**: http://localhost:5000/api-docs
- **官方网站**: 直接打开 `website/index.html`
## 🏗️ 项目架构
```
nxxmdata/
├── 📁 backend/ # 后端API服务
│ ├── config/ # 配置文件
│ ├── controllers/ # 控制器
│ ├── models/ # 数据模型
│ ├── routes/ # 路由定义
│ ├── middleware/ # 中间件
│ └── utils/ # 工具类
├── 📁 admin-system/ # 管理后台前端
│ ├── src/ # 源代码
│ ├── components/ # 组件库
│ └── views/ # 页面视图
├── 📁 datav/ # 数据可视化大屏
├── 📁 website/ # 官方网站
├── 📁 bank_mini_program/ # 银行端小程序
├── 📁 government-mini-program/ # 政府端小程序
├── 📁 insurance_mini_program/ # 保险端小程序
├── 📁 docs/ # 项目文档
└── 📁 scripts/ # 脚本工具
```
### 技术栈
**后端技术栈**
- Node.js 16.20.2 + Express.js
- Sequelize ORM + MySQL 8.0
- JWT认证 + bcryptjs加密
- Swagger API文档
- Winston日志系统
**前端技术栈**
- Vue 3.4.15 + Vite
- Ant Design Vue 4.0
- ECharts 5.4 数据可视化
- Pinia 状态管理
- Axios HTTP客户端
## 📚 文档
### 核心文档
- [📋 产品需求文档](docs/config/PRD.md) - 详细的业务需求和功能规格
- [🏗️ 系统架构文档](docs/config/arch.md) - 技术架构和系统设计
- [🔧 开发指南](docs/DEVELOPMENT.md) - 开发环境搭建和开发规范
- [🚀 部署指南](docs/DEPLOYMENT.md) - 生产环境部署说明
- [📖 API文档](docs/API.md) - 接口设计和使用说明
### 专项文档
- [🏦 银行端小程序文档](docs/银行端小程序产品需求文档.md)
- [🏛️ 政府端小程序文档](docs/政府端产品需求文档.md)
- [🛡️ 保险端小程序文档](docs/保险端产品需求文档.md)
- [🔒 安全说明](docs/SECURITY.md)
- [❓ 故障排除](docs/TROUBLESHOOTING.md)
## 🤝 贡献指南
我们欢迎所有形式的贡献!请阅读 [贡献指南](docs/CONTRIBUTING.md) 了解如何参与项目开发。
### 开发流程
1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request
### 代码规范
- 遵循 ESLint 配置
- 使用语义化提交信息
- 编写单元测试
- 更新相关文档
## 📄 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
## 📞 联系我们
- **项目维护者**: NXXM Development Team
- **技术支持**: [创建Issue](../../issues)
- **文档反馈**: [文档仓库](docs/)
## 🙏 致谢
感谢所有为项目做出贡献的开发者和用户!
---
<div align="center">
**⭐ 如果这个项目对你有帮助,请给我们一个星标!**
Made with ❤️ by NXXM Development Team
</div>