Files
nxxmdata/government-admin/README.md

191 lines
4.0 KiB
Markdown
Raw Normal View History

2025-09-17 18:04:28 +08:00
# 宁夏智慧养殖监管平台 - 政府端管理后台
## 项目简介
本项目是宁夏智慧养殖监管平台的政府端管理后台,基于 Vue 3 + Ant Design Vue 构建,为政府监管部门提供养殖场管理、设备监控、数据分析等功能。
## 技术栈
- **前端框架**: Vue 3.4+
- **构建工具**: Vite 5.0+
- **UI组件库**: Ant Design Vue 4.0+
- **状态管理**: Pinia 2.1+
- **路由管理**: Vue Router 4.2+
- **HTTP客户端**: Axios 1.6+
- **图表库**: ECharts 5.4+
- **样式预处理**: Sass
- **Node.js版本**: 16.x
## 功能特性
### 核心功能
- 🔐 用户认证与权限管理
- 🏠 养殖场信息管理
- 🗺️ 地图可视化展示
- 📊 设备监控与状态管理
- 🐄 动物健康管理
- ⚠️ 预警管理系统
- 📈 数据可视化与报表
- 👥 用户管理
- ⚙️ 系统设置
### 技术特性
- 📱 响应式设计,支持多端适配
- 🎨 现代化UI设计用户体验优良
- 🚀 基于Vite的快速开发体验
- 🔄 实时数据更新WebSocket
- 📦 组件化开发,代码复用性高
- 🛡️ 完善的权限控制系统
- 🌐 国际化支持(预留)
## 环境要求
- Node.js 16.x
- npm 8.0+ 或 yarn 1.22+
- 现代浏览器Chrome 88+, Firefox 78+, Safari 14+
## 快速开始
### 1. 克隆项目
```bash
git clone <repository-url>
cd government-admin
```
### 2. 安装依赖
```bash
# 使用npm
npm install
# 或使用yarn
yarn install
```
### 3. 配置环境变量
```bash
# 复制环境变量示例文件
cp .env.example .env
# 编辑 .env 文件配置API地址等信息
```
### 4. 启动开发服务器
```bash
# 使用npm
npm run dev
# 或使用yarn
yarn dev
```
### 5. 构建生产版本
```bash
# 使用npm
npm run build
# 或使用yarn
yarn build
```
## 项目结构
```
government-admin/
├── public/ # 静态资源
├── src/
│ ├── assets/ # 资源文件
│ ├── components/ # 通用组件
│ ├── layouts/ # 布局组件
│ ├── router/ # 路由配置
│ ├── stores/ # 状态管理
│ ├── styles/ # 样式文件
│ ├── utils/ # 工具函数
│ ├── views/ # 页面组件
│ ├── App.vue # 根组件
│ └── main.js # 入口文件
├── .env.example # 环境变量示例
├── .nvmrc # Node.js版本配置
├── index.html # HTML模板
├── package.json # 项目配置
├── vite.config.js # Vite配置
└── README.md # 项目说明
```
## 开发规范
### 代码规范
- 使用 ESLint + Prettier 进行代码格式化
- 组件命名使用 PascalCase
- 文件命名使用 kebab-case
- 变量命名使用 camelCase
### Git提交规范
```
feat: 新功能
fix: 修复bug
docs: 文档更新
style: 代码格式调整
refactor: 代码重构
test: 测试相关
chore: 构建过程或辅助工具的变动
```
## 部署说明
### 开发环境
```bash
npm run dev
```
访问: http://localhost:5400
### 生产环境
```bash
npm run build
npm run preview
```
### Docker部署
```bash
# 构建镜像
docker build -t government-admin .
# 运行容器
docker run -p 5400:80 government-admin
```
## API接口
后端API服务地址: http://localhost:5350/api
主要接口:
- `/auth/*` - 认证相关
- `/farms/*` - 养殖场管理
- `/devices/*` - 设备监控
- `/animals/*` - 动物管理
- `/alerts/*` - 预警管理
- `/reports/*` - 报表数据
- `/users/*` - 用户管理
## 浏览器支持
| Chrome | Firefox | Safari | Edge |
|--------|---------|--------|------|
| 88+ | 78+ | 14+ | 88+ |
## 许可证
MIT License
## 联系方式
- 项目维护: NXXM Development Team
- 技术支持: [技术支持邮箱]
- 问题反馈: [GitHub Issues]
## 更新日志
### v1.0.0 (2025-01-18)
- 🎉 初始版本发布
- ✨ 完成基础框架搭建
- ✨ 实现用户认证系统
- ✨ 完成基础布局和路由配置