添加 IntelliJ IDEA 项目配置文件
This commit is contained in:
251
README.md
251
README.md
@@ -1,47 +1,240 @@
|
||||
# NiuMall 项目
|
||||
# 活牛采购智能数字化系统 (NiuMall)
|
||||
|
||||
## 项目结构
|
||||
## 📋 项目概述
|
||||
|
||||
本项目采用模块化架构设计,包含以下主要目录:
|
||||
活牛采购智能数字化系统是一个专业的活牛采购全流程数字化管理解决方案,采用模块化设计架构,支持多端协同工作,实现从采购计划到最终结算的全链路数字化管理。
|
||||
|
||||
### 📁 backend - 后端服务
|
||||
后端API服务,基于Node.js/Java/Python等技术栈开发
|
||||
**项目特色:**
|
||||
- 🔄 **模块化架构**:前后端分离,各模块独立开发部署
|
||||
- 📱 **多端支持**:官网、管理后台、小程序矩阵全覆盖
|
||||
- 🔒 **统一认证**:单点登录,统一用户中心
|
||||
- 📊 **实时数据**:WebSocket实时数据同步
|
||||
- 🎯 **专业化**:专注活牛采购行业需求
|
||||
|
||||
### 📁 admin-system - 管理后台
|
||||
基于Vue/React的管理后台前端项目
|
||||
## 🏗️ 技术架构
|
||||
|
||||
### 📁 website - 官网
|
||||
公司官网或电商平台前端项目
|
||||
```
|
||||
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
|
||||
│ Website │ │ Admin System │ │ Mini Programs │
|
||||
│ (HTML5+CSS3) │ │ (Vue 3) │ │ (uni-app) │
|
||||
└─────────────────┘ └─────────────────┘ └─────────────────┘
|
||||
│ │ │
|
||||
└──────────┬───────────┴──────────┬───────────┘
|
||||
│ │
|
||||
┌────────┴─────────┐ ┌──────┴───────┐
|
||||
│ API Gateway │ │ 统一用户中心 │
|
||||
│ (Authentication)│ │(Single SSO) │
|
||||
└────────┬─────────┘ └──────┬───────┘
|
||||
│ │
|
||||
└──────────┬───────────┘
|
||||
│
|
||||
┌──────────┴──────────┐
|
||||
│ Backend Services │
|
||||
│ (Node.js) │
|
||||
└──────────┬──────────┘
|
||||
│
|
||||
┌──────────┴──────────┐
|
||||
│ Unified Database │
|
||||
│ (MySQL + Redis) │
|
||||
└─────────────────────┘
|
||||
```
|
||||
|
||||
### 📁 mini_program - 微信小程序矩阵
|
||||
包含多个微信小程序项目的目录
|
||||
## 📁 项目结构
|
||||
|
||||
### 📁 docs - 文档目录
|
||||
项目文档、API文档、设计文档等
|
||||
```
|
||||
niumall/
|
||||
├── 📂 docs/ # 📚 项目文档
|
||||
│ ├── 活牛采购智能数字化系统PRD.md
|
||||
│ ├── 技术实施方案.md
|
||||
│ ├── 官网需求文档.md
|
||||
│ └── Live-Cattle-Procurement-SOP-System-PRD.md
|
||||
├── 📂 website/ # 🌐 企业官网
|
||||
│ ├── index.html # 首页
|
||||
│ ├── css/custom.css # 自定义样式
|
||||
│ ├── js/main.js # 主要逻辑
|
||||
│ └── ...
|
||||
├── 📂 admin-system/ # 🔧 管理后台
|
||||
│ └── README.md # Vue 3 + TypeScript + Element Plus
|
||||
├── 📂 backend/ # ⚙️ 后端服务
|
||||
│ └── README.md # Node.js + Express + MySQL
|
||||
├── 📂 mini_program/ # 📱 小程序矩阵
|
||||
│ └── README.md # uni-app 跨平台开发
|
||||
└── 📂 test/ # 🧪 测试目录
|
||||
```
|
||||
|
||||
### 📁 test - 测试文件目录
|
||||
单元测试、集成测试、端到端测试等
|
||||
### 🌐 Website - 企业官网
|
||||
**技术栈**:HTML5 + Bootstrap 5 + 原生JavaScript
|
||||
- 企业品牌展示和产品介绍
|
||||
- 响应式设计,SEO优化
|
||||
- 客户案例和解决方案展示
|
||||
- 在线咨询和试用申请
|
||||
|
||||
## 开发规范
|
||||
### 🔧 Admin System - 管理后台
|
||||
**技术栈**:Vue 3 + TypeScript + Element Plus + Vite + Pinia
|
||||
- 用户管理和权限控制
|
||||
- 订单管理和流程监控
|
||||
- 数据统计和分析报表
|
||||
- 系统配置和维护
|
||||
|
||||
1. 每个目录下应有独立的package.json和开发配置
|
||||
2. 遵循统一的代码规范和提交规范
|
||||
3. 文档及时更新,保持与代码同步
|
||||
### 📱 Mini Program - 小程序矩阵
|
||||
**技术栈**:uni-app + Vue 3 + TypeScript
|
||||
- **客户端小程序**:采购订单创建和跟踪
|
||||
- **供应商小程序**:牛只管理和装车操作
|
||||
- **司机小程序**:运输跟踪和状态上报
|
||||
- **内部员工小程序**:内部操作和管理
|
||||
|
||||
## 快速开始
|
||||
### ⚙️ Backend - 后端服务
|
||||
**技术栈**:Node.js + Express + MySQL + Redis
|
||||
- 微服务架构设计
|
||||
- 统一API接口服务
|
||||
- 实时数据同步
|
||||
- 文件存储和处理
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 环境要求
|
||||
- Node.js >= 16.0.0
|
||||
- MySQL >= 5.7
|
||||
- Redis >= 6.0
|
||||
- 微信开发者工具(小程序开发)
|
||||
|
||||
### 数据库配置
|
||||
```bash
|
||||
# 安装依赖(根据具体项目)
|
||||
npm install
|
||||
# 数据库连接信息
|
||||
主机: 129.211.213.226
|
||||
端口: 9527
|
||||
用户名: root
|
||||
密码: aiotAiot123!
|
||||
数据库: jiebandata
|
||||
```
|
||||
|
||||
# 启动开发服务
|
||||
### 启动步骤
|
||||
|
||||
#### 1. 启动后端服务
|
||||
```bash
|
||||
cd backend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## 贡献指南
|
||||
#### 2. 启动管理后台
|
||||
```bash
|
||||
cd admin-system
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
1. Fork 项目
|
||||
2. 创建特性分支
|
||||
3. 提交更改
|
||||
4. 推送到分支
|
||||
5. 开启Pull Request
|
||||
#### 3. 启动企业官网
|
||||
```bash
|
||||
cd website
|
||||
# 直接用浏览器打开 index.html 或使用本地服务器
|
||||
python -m http.server 8080 # Python方式
|
||||
# 或
|
||||
npx serve . # Node.js方式
|
||||
```
|
||||
|
||||
#### 4. 小程序开发
|
||||
```bash
|
||||
cd mini_program
|
||||
npm install
|
||||
# 使用微信开发者工具打开对应小程序目录
|
||||
```
|
||||
|
||||
## 👥 用户角色
|
||||
|
||||
| 角色 | 职责 | 主要功能 |
|
||||
|------|------|----------|
|
||||
| 🏭 **采购人** | 发起采购需求,验收确认 | 订单创建、进度跟踪、验收支付 |
|
||||
| 🤝 **贸易商** | 订单转发,供应商管理 | 订单管理、供应商资质审核、结算处理 |
|
||||
| 🐄 **供应商** | 牛只准备,装车管理 | 牛只信息维护、证件上传、装车监控 |
|
||||
| 🚛 **司机** | 运输执行,状态上报 | 实时定位、运输跟踪、状态报告 |
|
||||
| 👨💼 **内部员工** | 系统管理,业务监督 | 用户管理、数据分析、异常处理 |
|
||||
|
||||
## 📊 核心功能
|
||||
|
||||
### 1. 采购订单管理
|
||||
- ✅ 订单创建和审核流程
|
||||
- ✅ 多级审批和权限控制
|
||||
- ✅ 订单状态实时跟踪
|
||||
- ✅ 异常处理和风险控制
|
||||
|
||||
### 2. 运输跟踪管理
|
||||
- 🚛 实时GPS定位跟踪
|
||||
- 📹 装车卸车视频监控
|
||||
- 📱 移动端状态上报
|
||||
- ⏰ 运输时效监控
|
||||
|
||||
### 3. 质检验收管理
|
||||
- 🔍 标准化质检流程
|
||||
- 📋 检疫证明管理
|
||||
- ⚖️ 称重数据记录
|
||||
- 🎯 质量标准配置
|
||||
|
||||
### 4. 结算支付管理
|
||||
- 💰 自动结算计算
|
||||
- 💳 在线支付支持
|
||||
- 📊 财务报表生成
|
||||
- 🔒 资金安全保障
|
||||
|
||||
## 🛠️ 开发规范
|
||||
|
||||
### 代码规范
|
||||
- **JavaScript/TypeScript**:遵循 ESLint + Prettier 规范
|
||||
- **Vue**:遵循 Vue 3 Composition API 最佳实践
|
||||
- **CSS**:使用 BEM 命名规范
|
||||
- **提交规范**:遵循 Conventional Commits
|
||||
|
||||
### 分支管理
|
||||
- `main`:主分支,生产环境代码
|
||||
- `develop`:开发分支,集成测试
|
||||
- `feature/*`:功能分支
|
||||
- `hotfix/*`:紧急修复分支
|
||||
|
||||
## 📈 部署方案
|
||||
|
||||
### 生产环境
|
||||
- **Web服务器**:Nginx + PM2
|
||||
- **数据库**:MySQL 主从复制
|
||||
- **缓存**:Redis 集群
|
||||
- **文件存储**:MinIO/阿里云OSS
|
||||
- **负载均衡**:Nginx Load Balancer
|
||||
|
||||
### 开发环境
|
||||
- **容器化**:Docker + Docker Compose
|
||||
- **CI/CD**:GitHub Actions
|
||||
- **监控**:Prometheus + Grafana
|
||||
- **日志**:ELK Stack
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
1. **Fork** 本仓库
|
||||
2. **创建**特性分支 (`git checkout -b feature/AmazingFeature`)
|
||||
3. **提交**更改 (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. **推送**到分支 (`git push origin feature/AmazingFeature`)
|
||||
5. **开启** Pull Request
|
||||
|
||||
### 提交信息规范
|
||||
```
|
||||
feat: 新功能
|
||||
fix: 修复bug
|
||||
docs: 文档更新
|
||||
style: 代码格式调整
|
||||
refactor: 代码重构
|
||||
test: 测试相关
|
||||
chore: 其他修改
|
||||
```
|
||||
|
||||
## 📞 联系我们
|
||||
|
||||
- **产品经理**:product@niumall.com
|
||||
- **技术支持**:tech@niumall.com
|
||||
- **商务合作**:business@niumall.com
|
||||
- **客服热线**:400-xxx-xxxx
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情
|
||||
|
||||
---
|
||||
|
||||
**🎯 让活牛采购更智能,让业务管理更简单!**
|
||||
Reference in New Issue
Block a user