Blame view

README.md 14.8 KB
df137fbd   “wangming”   更新README.md,完善项目介...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  # 绿纤美业ERP管理系统
  
  ## 📋 项目简介
  
  绿纤美业ERP管理系统是一个基于现代化技术栈开发的企业资源规划系统,专为绿纤美业行业量身定制。系统采用前后端分离架构,提供完整的门店管理、业绩统计、工资核算、报表分析、客户管理等业务管理功能。
  
  **项目状态**:✅ 生产环境运行中 | 📅 最后更新:2025年1月
  
  ## 🎯 核心功能模块
  
  ### 📊 业绩统计系统
  - **个人业绩统计** - 健康师个人业绩统计,包含首单业绩、升单业绩等
  - **门店总业绩统计** - 门店整体业绩统计,包含总业绩、欠款金额等
  - **金三角业绩统计** - 金三角团队业绩统计和分析
  - **部门消耗业绩统计** - 部门消耗业绩统计,包含人头数、人次等
  - **科技部业绩统计** - 科技部老师业绩统计
  - **门店消耗业绩统计** - 门店消耗业绩统计
  
  ### 💰 工资核算系统
  - **健康师工资核算** - 健康师底薪、提成、奖励等自动计算
  - **店长工资核算** - 店长工资计算,包含底薪、提成、奖励等
  - **主任工资核算** - 主任工资计算,包含底薪、提成、奖励等
  - **大项目主管工资核算** - 大项目主管工资计算
  - **科技部总经理工资核算** - 科技部总经理工资计算
  - **事业部总经理工资核算** - 事业部总经理工资计算
  
  ### 📈 报表分析系统
  - **门店业绩趋势** - 门店业绩时间趋势分析
  - **门店业绩排行榜** - 门店业绩排名统计
  - **健康师业绩趋势** - 健康师个人业绩趋势
  - **健康师业绩排行榜** - 健康师业绩排名统计
  - **金三角业绩趋势** - 金三角团队业绩趋势
  - **综合仪表盘** - 多维度数据汇总展示
  
  ### 🏪 门店管理系统
  - **门店信息管理** - 门店基础信息维护
  - **门店归属管理** - 门店归属事业部、教育部、科技部等
  - **新店保护时间** - 新店保护期管理
  - **门店股份统计** - 门店股份统计和分析
bdf9e891   “wangming”   更新.gitignore以包含.z...
40
  
df137fbd   “wangming”   更新README.md,完善项目介...
41
42
43
44
  ### 👥 人员管理系统
  - **金三角设定** - 金三角团队配置管理
  - **金三角用户绑定** - 用户与金三角团队绑定关系
  - **顾问身份管理** - 根据金三角绑定自动设置顾问身份
47d33dca   “wangming”   国庆快乐~
45
  
df137fbd   “wangming”   更新README.md,完善项目介...
46
47
48
49
50
51
  ### 📋 客户管理系统
  - **客户信息管理** - 客户档案管理
  - **拓客记录管理** - 拓客活动记录
  - **拓客活动管理** - 拓客活动配置
  - **会员权益管理** - 历史会员权益数据管理
  - **用户画像** - 会员画像数据分析和展示
47d33dca   “wangming”   国庆快乐~
52
  
df137fbd   “wangming”   更新README.md,完善项目介...
53
54
55
56
57
58
  ### 🔧 其他业务模块
  - **合同管理系统** - 合同信息管理
  - **合作成本管理** - 合作成本表管理
  - **店内支出管理** - 店内支出表管理
  - **库存使用审批** - 库存使用审批流程
  - **年度汇总统计** - 年度经营统计分析
bdf9e891   “wangming”   更新.gitignore以包含.z...
59
  
df137fbd   “wangming”   更新README.md,完善项目介...
60
  ## 🛠 技术栈
bdf9e891   “wangming”   更新.gitignore以包含.z...
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  
  ### 后端技术
  - **.NET Core 3.1/5.0** - 跨平台Web框架
  - **SqlSugar** - 轻量级ORM框架
  - **MySQL** - 关系型数据库
  - **JWT** - 身份认证
  - **Serilog** - 结构化日志
  - **Swagger** - API文档
  
  ### 前端技术
  - **Vue 2.6** - 渐进式JavaScript框架
  - **Element UI** - 企业级UI组件库
  - **Vuex** - 状态管理
  - **Vue Router** - 路由管理
  - **Axios** - HTTP客户端
  - **SCSS** - CSS预处理器
47d33dca   “wangming”   国庆快乐~
77
  - **ECharts** - 数据可视化图表库
bdf9e891   “wangming”   更新.gitignore以包含.z...
78
  
df137fbd   “wangming”   更新README.md,完善项目介...
79
80
81
82
83
  ### 移动端
  - **uni-app** - 跨平台移动应用框架
  - **微信小程序** - 支持微信小程序平台
  
  ## 📁 项目结构
bdf9e891   “wangming”   更新.gitignore以包含.z...
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
  
  ```
  lvqianmeiye_ERP/
  ├── netcore/                    # 后端.NET Core项目
  │   └── src/
  │       ├── Application/        # 应用层
  │       ├── Infrastructure/     # 基础设施层
  │       └── Modularity/         # 业务模块层
  │           ├── System/         # 系统管理模块
  │           ├── Extend/         # 🎯 核心业务模块(绿纤ERP业务逻辑)
  │           │   ├── NCC.Extend/           # 业务服务层
  │           │   ├── NCC.Extend.Entitys/   # 实体模型层
  │           │   └── NCC.Extend.Interfaces/ # 接口定义层
  │           ├── OAuth/          # 身份认证模块
  │           ├── Message/        # 消息中心模块
  │           ├── Order/          # 订单管理模块
  │           ├── VisualDev/      # 可视化开发模块
  │           └── Tenant/         # 多租户支持模块
df137fbd   “wangming”   更新README.md,完善项目介...
102
  ├── antis-ncc-admin/           # 前端Vue管理后台
bdf9e891   “wangming”   更新.gitignore以包含.z...
103
104
105
106
  │   ├── src/
  │   │   ├── api/               # API接口
  │   │   ├── components/        # 公共组件
  │   │   ├── views/             # 页面视图
47d33dca   “wangming”   国庆快乐~
107
108
109
110
111
112
113
  │   │   │   ├── salaryStatistics/  # 工资统计页面
  │   │   │   ├── personalPerformanceStatistics/  # 个人业绩统计
  │   │   │   ├── storeTotalPerformanceStatistics/  # 门店总业绩统计
  │   │   │   ├── departmentConsumePerformanceStatistics/  # 部门消耗业绩统计
  │   │   │   ├── techPerformanceStatistics/  # 科技部业绩统计
  │   │   │   ├── storeConsumePerformanceStatistics/  # 门店消耗业绩统计
  │   │   │   ├── report/        # 报表分析页面
df137fbd   “wangming”   更新README.md,完善项目介...
114
  │   │   │   └── extend/       # 其他业务页面
bdf9e891   “wangming”   更新.gitignore以包含.z...
115
116
117
118
  │   │   ├── router/            # 路由配置
  │   │   └── store/             # 状态管理
  │   ├── package.json           # 前端依赖配置
  │   └── vue.config.js          # Vue构建配置
df137fbd   “wangming”   更新README.md,完善项目介...
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
  ├── 绿纤uni-app/              # 移动端uni-app项目
  │   ├── pages/                 # 页面文件
  │   ├── components/            # 组件
  │   ├── apis/                  # API接口
  │   └── service/               # 服务层
  ├── 绿纤html/                 # 静态HTML页面
  │   ├── appointment.html       # 预约页面
  │   ├── expansion.html         # 拓客页面
  │   ├── member-consume.html   # 会员消耗页面
  │   └── ...                    # 其他页面
  ├── docs/                      # 📚 项目文档
  │   ├── 数据库说明.md          # 数据库文档
  │   ├── 工资计算规则梳理.md    # 工资计算规则文档
  │   ├── 接口文档.md            # API接口文档
  │   └── ...                    # 其他需求文档
  ├── scripts/                   # 🔧 脚本工具
  │   ├── sh/                    # Shell测试脚本
  │   │   ├── test_*.sh         # 接口测试脚本
  │   │   └── verify_*.sh        # 数据验证脚本
  │   └── py/                    # Python工具脚本
  │       ├── export_*.py        # 数据导出脚本
  │       └── generate_*.py     # 数据生成脚本
  ├── sql/                       # 📊 SQL脚本
  │   ├── 表结构.sql             # 数据库表结构
  │   ├── 初始化数据.sql         # 初始化数据脚本
  │   └── ...                    # 其他SQL脚本
  ├── excel/                     # 📄 Excel模板文件
  │   ├── 健康师额外数据模板.xlsx
  │   ├── 合作成本表.xlsx
  │   └── ...                    # 其他模板文件
  ├── ExportFiles/               # 📤 导出文件目录
  ├── PROJECT_RULES.md           # 项目开发规范
  └── README.md                  # 项目说明文档
bdf9e891   “wangming”   更新.gitignore以包含.z...
152
153
154
155
156
157
158
  ```
  
  ## 🎯 核心业务模块说明
  
  **Extend模块**是系统的核心业务模块,包含绿纤ERP的所有业务逻辑。该模块采用三层架构设计:
  
  ### NCC.Extend(业务服务层)
bdf9e891   “wangming”   更新.gitignore以包含.z...
159
  
47d33dca   “wangming”   国庆快乐~
160
161
162
163
164
  #### 📊 业绩统计类
  - `LqStatisticsService` - 核心统计服务(个人业绩、门店业绩、金三角业绩等)
  - `LqReportService` - 报表分析服务(趋势图、排行榜、仪表盘)
  
  #### 💰 工资核算类
df137fbd   “wangming”   更新README.md,完善项目介...
165
166
167
168
169
170
  - `LqGzService` - 健康师工资核算服务
  - `LqStoreManagerSalaryService` - 店长工资核算服务
  - `LqDirectorSalaryService` - 主任工资核算服务
  - `LqMajorProjectDirectorSalaryService` - 大项目主管工资核算服务
  - `LqTechGeneralManagerSalaryService` - 科技部总经理工资核算服务
  - `LqBusinessUnitManagerSalaryService` - 事业部总经理工资核算服务
47d33dca   “wangming”   国庆快乐~
171
172
173
174
175
176
177
178
179
180
  
  #### 🏪 门店管理类
  - `LqMdxxService` - 门店信息管理服务
  - `LqMdXdbhsjService` - 门店新店保护时间管理
  
  #### 👥 人员管理类
  - `LqYcsdJsjService` - 金三角设定管理服务
  - `LqJinsanjiaoUserService` - 金三角用户绑定管理
  
  #### 📋 客户管理类
bdf9e891   “wangming”   更新.gitignore以包含.z...
181
  - `LqKhxxService` - 客户信息管理服务
47d33dca   “wangming”   国庆快乐~
182
183
  - `LqTkjlbService` - 拓客记录管理服务
  - `LqEventService` - 拓客活动管理服务
bdf9e891   “wangming”   更新.gitignore以包含.z...
184
185
186
187
188
189
190
191
  
  #### 🔧 系统工具类
  - `EmailService` - 邮件服务
  - `DocumentService` - 文档管理服务
  - `BigDataService` - 大数据分析服务
  - `WorkLogService` - 工作日志服务
  
  ### NCC.Extend.Entitys(实体模型层)
df137fbd   “wangming”   更新README.md,完善项目介...
192
193
  - **Entity/** - 数据库实体模型
  - **Dto/** - 数据传输对象
47d33dca   “wangming”   国庆快乐~
194
  - **Mapper/** - 对象映射配置
bdf9e891   “wangming”   更新.gitignore以包含.z...
195
196
  - **Model/** - 业务模型类
  
df137fbd   “wangming”   更新README.md,完善项目介...
197
  ## 🚀 快速开始
bdf9e891   “wangming”   更新.gitignore以包含.z...
198
  
df137fbd   “wangming”   更新README.md,完善项目介...
199
  ### 环境要求
bdf9e891   “wangming”   更新.gitignore以包含.z...
200
  
df137fbd   “wangming”   更新README.md,完善项目介...
201
202
  #### 开发环境
  - **Node.js**: 16.20.2 (⚠️ 必须使用此版本,其他版本可能不兼容)
bdf9e891   “wangming”   更新.gitignore以包含.z...
203
204
205
206
  - **.NET Core SDK**: 3.1 或 5.0
  - **MySQL**: 5.7 或 8.0
  - **Visual Studio 2019/2022****VS Code**
  
df137fbd   “wangming”   更新README.md,完善项目介...
207
  #### 浏览器支持
bdf9e891   “wangming”   更新.gitignore以包含.z...
208
209
210
211
212
  - Chrome 70+
  - Firefox 65+
  - Safari 12+
  - Edge 79+
  
bdf9e891   “wangming”   更新.gitignore以包含.z...
213
  ### 1. 克隆项目
df137fbd   “wangming”   更新README.md,完善项目介...
214
  
bdf9e891   “wangming”   更新.gitignore以包含.z...
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
  ```bash
  git clone [项目地址]
  cd lvqianmeiye_ERP
  ```
  
  ### 2. 后端启动
  
  #### 方式一:Visual Studio
  1. 打开 `netcore/smart.agriculture.platform.NET.sln`
  2. 设置 `NCC.API` 为启动项目
  3. 按 F5 运行
  
  #### 方式二:命令行
  ```bash
  cd netcore/src/Application/NCC.API
  dotnet restore
  dotnet run
  ```
  
  ### 3. 前端启动
  
  ```bash
  cd antis-ncc-admin
  
  # 安装依赖
  npm install
  
  # 启动开发服务器
  npm run dev
  ```
  
  ### 4. 访问系统
  - 前端地址:http://localhost:3000
  - 后端API:http://localhost:5000
  - API文档:http://localhost:5000/antis.doc
  
df137fbd   “wangming”   更新README.md,完善项目介...
251
  ### 默认账号
bdf9e891   “wangming”   更新.gitignore以包含.z...
252
253
254
  - **管理员账号**:admin
  - **默认密码**:123456
  
df137fbd   “wangming”   更新README.md,完善项目介...
255
  ## 📚 项目文档
47d33dca   “wangming”   国庆快乐~
256
  
df137fbd   “wangming”   更新README.md,完善项目介...
257
  项目文档统一存放在 `docs/` 目录下,包含:
47d33dca   “wangming”   国庆快乐~
258
  
df137fbd   “wangming”   更新README.md,完善项目介...
259
260
261
  ### 核心文档
  - **数据库说明.md** - 数据库表结构、字段说明、关联关系
  - **PROJECT_RULES.md** - 项目开发规范、编码规范、最佳实践
bdf9e891   “wangming”   更新.gitignore以包含.z...
262
  
df137fbd   “wangming”   更新README.md,完善项目介...
263
264
265
266
267
268
269
270
271
272
  ### 业务文档
  - **工资计算规则梳理.md** - 各类工资计算规则说明
    - 健康师工资计算规则
    - 店长工资计算规则
    - 主任工资计算规则
    - 大项目主管工资计算规则
    - 科技部总经理工资计算规则
    - 事业部总经理工资计算规则
  - **接口文档.md** - API接口调用说明
  - **需求分析文档** - 各类业务需求分析文档
bdf9e891   “wangming”   更新.gitignore以包含.z...
273
  
df137fbd   “wangming”   更新README.md,完善项目介...
274
275
276
277
  ### 查看文档
  ```bash
  # 查看所有文档
  ls docs/
bdf9e891   “wangming”   更新.gitignore以包含.z...
278
  
df137fbd   “wangming”   更新README.md,完善项目介...
279
280
  # 查看特定文档
  cat docs/数据库说明.md
bdf9e891   “wangming”   更新.gitignore以包含.z...
281
282
  ```
  
df137fbd   “wangming”   更新README.md,完善项目介...
283
284
285
286
287
288
  ## 🔧 脚本工具
  
  项目提供了丰富的脚本工具,位于 `scripts/` 目录下:
  
  ### Shell测试脚本 (`scripts/sh/`)
  用于接口测试和数据验证:
bdf9e891   “wangming”   更新.gitignore以包含.z...
289
  ```bash
df137fbd   “wangming”   更新README.md,完善项目介...
290
291
  # 测试个人业绩统计接口
  ./scripts/sh/test_personal_performance_api.sh
bdf9e891   “wangming”   更新.gitignore以包含.z...
292
  
df137fbd   “wangming”   更新README.md,完善项目介...
293
294
  # 测试门店总业绩统计接口
  ./scripts/sh/test_store_total_performance_statistics.sh
bdf9e891   “wangming”   更新.gitignore以包含.z...
295
  
df137fbd   “wangming”   更新README.md,完善项目介...
296
297
298
299
300
301
302
303
304
  # 验证门店总业绩数据
  ./scripts/sh/verify_store_total_performance_data.sh
  ```
  
  ### Python工具脚本 (`scripts/py/`)
  用于数据导出和生成:
  ```bash
  # 导出所有会员剩余权益数据
  python scripts/py/export_all_member_remaining_rights.py
bdf9e891   “wangming”   更新.gitignore以包含.z...
305
  
df137fbd   “wangming”   更新README.md,完善项目介...
306
307
  # 生成客户Excel数据
  python scripts/py/generate_november_customer_excel.py
bdf9e891   “wangming”   更新.gitignore以包含.z...
308
309
  ```
  
df137fbd   “wangming”   更新README.md,完善项目介...
310
311
312
313
314
315
316
317
318
319
  ## 📊 SQL脚本
  
  数据库相关SQL脚本存放在 `sql/` 目录下:
  
  - **表结构脚本** - 数据库表结构定义
  - **初始化数据脚本** - 系统初始化数据
  - **数据迁移脚本** - 数据库版本升级脚本
  - **统计脚本** - 统计数据生成脚本
  
  ## ⚙️ 配置说明
bdf9e891   “wangming”   更新.gitignore以包含.z...
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
  
  ### 数据库配置
  修改 `netcore/src/Application/NCC.API/appsettings.json` 中的连接字符串:
  
  ```json
  {
    "ConnectionStrings": {
      "DefaultConnection": "Database=lqerp;Data Source=localhost;Port=3306;User Id=root;Password=yourpassword;Charset=utf8;"
    }
  }
  ```
  
  ### 前端代理配置
  修改 `antis-ncc-admin/vue.config.js` 中的代理地址:
  
  ```javascript
  proxy: {
    '/dev': {
      target: 'http://localhost:5000', // 后端API地址
      changeOrigin: true,
      pathRewrite: {
        '^/dev': ''
      }
    }
  }
  ```
  
df137fbd   “wangming”   更新README.md,完善项目介...
347
  ## 📦 部署说明
bdf9e891   “wangming”   更新.gitignore以包含.z...
348
349
350
351
352
353
354
355
356
357
358
  
  ### 后端部署
  1. 发布项目:`dotnet publish -c Release`
  2. 配置数据库连接字符串
  3. 部署到IIS或Linux服务器
  
  ### 前端部署
  1. 构建项目:`npm run build`
  2.`dist` 目录部署到Web服务器
  3. 配置Nginx或IIS反向代理
  
df137fbd   “wangming”   更新README.md,完善项目介...
359
360
361
  ## 📋 开发规范
  
  详细的开发规范请参考 [PROJECT_RULES.md](./PROJECT_RULES.md),主要规范包括:
47d33dca   “wangming”   国庆快乐~
362
  
df137fbd   “wangming”   更新README.md,完善项目介...
363
364
  ### 核心规范
  - **ID生成规范**: 必须使用 `YitIdHelper.NextId().ToString()` 生成ID
47d33dca   “wangming”   国庆快乐~
365
366
367
  - **API接口规范**: GET请求使用data字段传参,不使用params
  - **权限控制**: 所有数据查询必须添加园区权限过滤
  - **数据一致性**: 统计数据和列表数据必须使用相同的过滤条件
df137fbd   “wangming”   更新README.md,完善项目介...
368
369
370
  - **SQL查询验证**: 统计类型SQL查询必须先使用MCP MySQL工具验证
  
  ### 前端规范
47d33dca   “wangming”   国庆快乐~
371
372
373
  - **组件开发**: views 与 components 分离,弹窗、二级页面必须单独创建 Vue 文件
  - **文件命名**: 使用 kebab-case (如: user-dialog.vue)
  - **UI规范**: 统一使用 NCC-table,标签右对齐,卡片高度100px,内边距12px,圆角12px
47d33dca   “wangming”   国庆快乐~
374
  
df137fbd   “wangming”   更新README.md,完善项目介...
375
376
377
378
379
380
  ### 后端规范
  - **分层架构**: Entitys → Interfaces → Services
  - **异常处理**: 全局捕获,统一 JSON 格式返回
  - **XML注释**: 关键方法必须添加 XML 注释
  
  ## ❓ 常见问题
bdf9e891   “wangming”   更新.gitignore以包含.z...
381
382
  
  ### Q: 前端启动失败
df137fbd   “wangming”   更新README.md,完善项目介...
383
  **A**: 确保使用Node.js 16.20.2版本,其他版本可能不兼容
bdf9e891   “wangming”   更新.gitignore以包含.z...
384
385
  
  ### Q: 后端连接数据库失败
df137fbd   “wangming”   更新README.md,完善项目介...
386
  **A**: 检查数据库连接字符串和MySQL服务状态
bdf9e891   “wangming”   更新.gitignore以包含.z...
387
388
  
  ### Q: 权限验证失败
df137fbd   “wangming”   更新README.md,完善项目介...
389
  **A**: 检查JWT配置和Token有效期设置
bdf9e891   “wangming”   更新.gitignore以包含.z...
390
  
47d33dca   “wangming”   国庆快乐~
391
  ### Q: 统计SQL执行失败
df137fbd   “wangming”   更新README.md,完善项目介...
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
  **A**: 使用MCP MySQL工具先验证SQL语法和字段名是否正确
  
  ### Q: 接口测试脚本无法运行
  **A**: 确保脚本有执行权限:`chmod +x scripts/sh/*.sh`
  
  ## 📈 项目状态
  
  ### ✅ 已完成功能
  - [x] 业绩统计系统(个人、门店、金三角、部门消耗、科技部、门店消耗)
  - [x] 工资核算系统(健康师、店长、主任、大项目主管、科技部总经理、事业部总经理)
  - [x] 报表分析系统(趋势图、排行榜、仪表盘)
  - [x] 门店管理系统(门店信息、归属管理、新店保护)
  - [x] 客户管理系统(客户信息、拓客记录、会员权益)
  - [x] 合同管理系统
  - [x] 合作成本和店内支出管理
  - [x] 库存使用审批流程
  - [x] 年度汇总统计
  
  ### 🔄 持续优化
  - 性能优化
  - 代码重构
  - 文档完善
  - 测试覆盖
  
  ## 📞 技术支持
  
  如有技术问题,请:
  1. 查看项目文档:`docs/` 目录
  2. 查看开发规范:`PROJECT_RULES.md`
  3. 联系开发团队
  
  ## 📝 版本信息
  
  - **当前版本**:v2.5.0
  - **最后更新**:2025年1月
  - **维护状态**:✅ 生产环境运行中
  - **主要特性**:完整的业绩统计、工资核算、报表分析等核心功能
bdf9e891   “wangming”   更新.gitignore以包含.z...
429
430
431
432
  
  ---
  
  **注意**:本项目仅供学习和内部使用,请勿用于商业用途。