Blame view

README.md 7.83 KB
ba386929   “wangming”   docs: update READ...
1
  # 绿纤美业 ERP
bdf9e891   “wangming”   更新.gitignore以包含.z...
2
  
ba386929   “wangming”   docs: update READ...
3
  > 面向绿纤美业的企业资源规划系统,前后端分离,覆盖门店管理、业绩统计、工资核算、报表分析与客户管理等核心业务。
bdf9e891   “wangming”   更新.gitignore以包含.z...
4
  
ba386929   “wangming”   docs: update READ...
5
  **状态**:生产环境运行中 · **版本**:v2.5.0 · **更新**:2025年1月
bdf9e891   “wangming”   更新.gitignore以包含.z...
6
  
ba386929   “wangming”   docs: update READ...
7
  ---
bdf9e891   “wangming”   更新.gitignore以包含.z...
8
  
ba386929   “wangming”   docs: update READ...
9
  ## 功能概览
bdf9e891   “wangming”   更新.gitignore以包含.z...
10
  
ba386929   “wangming”   docs: update READ...
11
12
13
14
15
16
17
18
19
  | 模块         | 说明 |
  |--------------|------|
  | **业绩统计** | 个人 / 门店总 / 金三角 / 部门消耗 / 科技部 / 门店消耗业绩统计 |
  | **工资核算** | 健康师、店长、主任、大项目主管、科技部总经理、事业部总经理工资计算 |
  | **报表分析** | 门店/健康师/金三角业绩趋势、排行榜、综合仪表盘 |
  | **门店管理** | 门店信息、归属管理、新店保护、股份统计 |
  | **人员管理** | 金三角设定与用户绑定、顾问身份管理 |
  | **客户管理** | 客户档案、拓客记录与活动、会员权益、用户画像 |
  | **其他**      | 合同、合作成本、店内支出、库存使用审批、年度汇总 |
47d33dca   “wangming”   国庆快乐~
20
  
ba386929   “wangming”   docs: update READ...
21
  ---
47d33dca   “wangming”   国庆快乐~
22
  
ba386929   “wangming”   docs: update READ...
23
  ## 技术栈
47d33dca   “wangming”   国庆快乐~
24
  
ba386929   “wangming”   docs: update READ...
25
26
27
  | 端     | 技术 |
  |--------|------|
  | **后端** | .NET Core 3.1/5.0 · SqlSugar · MySQL · JWT · Serilog · Swagger |
ae4faf34   “wangming”   Update README and...
28
29
  | **管理后台** | Vue 2.6 · Element UI · Vuex · Vue Router · Axios · SCSS · ECharts(antis-ncc-admin) |
  | **门店 PC 端** | Vue 2.6 · Element UI · Vuex · Vue Router · Axios(store-pc,门店侧使用) |
ba386929   “wangming”   docs: update READ...
30
  | **移动端** | uni-app(支持微信小程序) |
47d33dca   “wangming”   国庆快乐~
31
  
ba386929   “wangming”   docs: update READ...
32
  ---
bdf9e891   “wangming”   更新.gitignore以包含.z...
33
  
ba386929   “wangming”   docs: update READ...
34
  ## 项目结构
bdf9e891   “wangming”   更新.gitignore以包含.z...
35
  
ba386929   “wangming”   docs: update READ...
36
37
38
39
40
41
42
43
44
45
46
  ```
  lvqianmeiye_ERP/
  ├── netcore/                    # 后端
  │   └── src/
  │       ├── Application/        # 应用入口(NCC.API)
  │       ├── Infrastructure/     # 基础设施(SqlSugar、JWT、日志等)
  │       └── Modularity/
  │           ├── Extend/         # 绿纤 ERP 核心业务(NCC.Extend / Entitys / Interfaces)
  │           ├── System/         # 系统管理
  │           ├── OAuth/          # 认证
  │           └── ...
ae4faf34   “wangming”   Update README and...
47
  ├── antis-ncc-admin/            # 前端管理后台(Vue,运营/总部使用)
ba386929   “wangming”   docs: update READ...
48
49
50
51
52
  │   └── src/
  │       ├── api/                # 接口封装
  │       ├── views/              # 页面(业绩、工资、报表、门店、客户等)
  │       ├── components/         # 公共组件
  │       └── router/、store/
ae4faf34   “wangming”   Update README and...
53
  ├── store-pc/                   # 门店 PC 端(Vue,门店侧使用,见 store-pc/README.md)
ba386929   “wangming”   docs: update READ...
54
  ├── 绿纤uni-app/                # 移动端
d8035736   “wangming”   Refactor project ...
55
56
57
58
59
60
  ├── ExportFiles/                # 接口导出、工资导入等生成文件(后端写入仓库根目录,见代码)
  ├── 项目文档相关/               # 文档、脚本、SQL、Excel 等(见该目录 README)
  │   ├── docs/                   # Markdown 文档(含数据库说明.md)
  │   ├── scripts/                # Shell / Python 辅助脚本
  │   ├── sql/                    # 迁移与统计 SQL
  │   └── excel/                  # Excel 模板
ba386929   “wangming”   docs: update READ...
61
62
  └── PROJECT_RULES.md            # 开发规范(必读)
  ```
bdf9e891   “wangming”   更新.gitignore以包含.z...
63
  
ae4faf34   “wangming”   Update README and...
64
65
  **说明****store-pc** 为门店的 PC 端应用,供门店侧使用;**antis-ncc-admin** 为管理后台,供运营/总部使用。二者为不同前端工程。
  
ba386929   “wangming”   docs: update READ...
66
  ---
bdf9e891   “wangming”   更新.gitignore以包含.z...
67
  
ba386929   “wangming”   docs: update READ...
68
  ## 快速开始
bdf9e891   “wangming”   更新.gitignore以包含.z...
69
  
ba386929   “wangming”   docs: update READ...
70
  ### 环境要求
bdf9e891   “wangming”   更新.gitignore以包含.z...
71
  
ba386929   “wangming”   docs: update READ...
72
73
74
75
  - **Node.js**:16.20.2(必须,其他版本可能不兼容)
  - **.NET Core SDK**:3.1 或 5.0
  - **MySQL**:5.7 或 8.0
  - **IDE**:Visual Studio 2019/2022 或 VS Code
bdf9e891   “wangming”   更新.gitignore以包含.z...
76
  
ba386929   “wangming”   docs: update READ...
77
  ### 克隆与启动
df137fbd   “wangming”   更新README.md,完善项目介...
78
  
bdf9e891   “wangming”   更新.gitignore以包含.z...
79
80
81
82
83
  ```bash
  git clone [项目地址]
  cd lvqianmeiye_ERP
  ```
  
ba386929   “wangming”   docs: update READ...
84
  **后端**
bdf9e891   “wangming”   更新.gitignore以包含.z...
85
  
bdf9e891   “wangming”   更新.gitignore以包含.z...
86
87
88
89
90
91
  ```bash
  cd netcore/src/Application/NCC.API
  dotnet restore
  dotnet run
  ```
  
ba386929   “wangming”   docs: update READ...
92
93
  或使用 Visual Studio:打开 `netcore/smart.agriculture.platform.NET.sln`,将 `NCC.API` 设为启动项目,F5 运行。
  
ae4faf34   “wangming”   Update README and...
94
  **前端(管理后台)**
bdf9e891   “wangming”   更新.gitignore以包含.z...
95
96
97
  
  ```bash
  cd antis-ncc-admin
bdf9e891   “wangming”   更新.gitignore以包含.z...
98
  npm install
bdf9e891   “wangming”   更新.gitignore以包含.z...
99
100
101
  npm run dev
  ```
  
ae4faf34   “wangming”   Update README and...
102
103
104
105
106
107
108
109
110
111
  **门店 PC 端(store-pc)**
  
  ```bash
  cd store-pc
  npm install
  npm run dev
  ```
  
  默认端口:管理后台 3000,门店 PC 端 3100。详见各目录下 README。
  
ba386929   “wangming”   docs: update READ...
112
  ### 访问与默认账号
bdf9e891   “wangming”   更新.gitignore以包含.z...
113
  
ba386929   “wangming”   docs: update READ...
114
115
  | 项     | 地址/信息 |
  |--------|-----------|
ae4faf34   “wangming”   Update README and...
116
117
  | 管理后台 | http://localhost:3000 |
  | 门店 PC 端 | http://localhost:3100(store-pc) |
ba386929   “wangming”   docs: update READ...
118
119
120
  | 后端 API | http://localhost:5000 |
  | API 文档 | http://localhost:5000/antis.doc |
  | 默认账号 | admin / 123456 |
bdf9e891   “wangming”   更新.gitignore以包含.z...
121
  
ba386929   “wangming”   docs: update READ...
122
  ---
df137fbd   “wangming”   更新README.md,完善项目介...
123
  
ba386929   “wangming”   docs: update READ...
124
  ## 配置
bdf9e891   “wangming”   更新.gitignore以包含.z...
125
  
ba386929   “wangming”   docs: update READ...
126
  **数据库**:修改 `netcore/src/Application/NCC.API/appsettings.json` 中的 `ConnectionStrings.DefaultConnection`
bdf9e891   “wangming”   更新.gitignore以包含.z...
127
128
  
  ```json
ba386929   “wangming”   docs: update READ...
129
  "DefaultConnection": "Database=lqerp;Data Source=localhost;Port=3306;User Id=root;Password=你的密码;Charset=utf8;"
bdf9e891   “wangming”   更新.gitignore以包含.z...
130
131
  ```
  
ba386929   “wangming”   docs: update READ...
132
  **前端代理**:修改 `antis-ncc-admin/vue.config.js` 中 `proxy['/dev'].target` 为实际后端地址(默认 `http://localhost:5000`)。
bdf9e891   “wangming”   更新.gitignore以包含.z...
133
  
ba386929   “wangming”   docs: update READ...
134
  ---
bdf9e891   “wangming”   更新.gitignore以包含.z...
135
  
ba386929   “wangming”   docs: update READ...
136
  ## 文档与脚本
bdf9e891   “wangming”   更新.gitignore以包含.z...
137
  
d8035736   “wangming”   Refactor project ...
138
139
140
  - **统一目录**`项目文档相关/`(子目录说明见 `项目文档相关/README.md`
  
  - **文档**`项目文档相关/docs/`  
ba386929   “wangming”   docs: update READ...
141
    - `数据库说明.md`:表结构、字段、关联与弃用表说明  
d8035736   “wangming”   Refactor project ...
142
143
144
    - 另有工资规则、接口说明、测试报告等 Markdown  
  
  - **脚本**`项目文档相关/scripts/sh/`(接口测试、数据验证)、`项目文档相关/scripts/py/`(导出、生成等)。在**仓库根目录**执行;Shell 需执行权限:`chmod +x 项目文档相关/scripts/sh/*.sh`
df137fbd   “wangming”   更新README.md,完善项目介...
145
  
d8035736   “wangming”   Refactor project ...
146
  - **SQL**`项目文档相关/sql/` 存放表结构、初始化、迁移及统计相关脚本。
47d33dca   “wangming”   国庆快乐~
147
  
d8035736   “wangming”   Refactor project ...
148
  - **导出文件**:后端仍写入仓库根目录 `ExportFiles/`(与既有 `Path.Combine(projectRoot, "ExportFiles")` 一致)。
df137fbd   “wangming”   更新README.md,完善项目介...
149
  
ba386929   “wangming”   docs: update READ...
150
  ---
47d33dca   “wangming”   国庆快乐~
151
  
ba386929   “wangming”   docs: update READ...
152
  ## 核心业务模块(Extend)
df137fbd   “wangming”   更新README.md,完善项目介...
153
  
ba386929   “wangming”   docs: update READ...
154
  业务逻辑集中在 `netcore/src/Modularity/Extend/`,服务通过动态 API 暴露为 `api/Extend/[ServiceName]`
bdf9e891   “wangming”   更新.gitignore以包含.z...
155
  
ba386929   “wangming”   docs: update READ...
156
157
158
159
160
161
162
163
  | 业务       | 主要服务类 |
  |------------|------------|
  | 业绩统计   | `LqStatisticsService`、`LqReportService` |
  | 工资核算   | `LqGzService`、`LqStoreManagerSalaryService`、`LqDirectorSalaryService`、`LqMajorProjectDirectorSalaryService`、`LqTechGeneralManagerSalaryService`、`LqBusinessUnitManagerSalaryService` |
  | 门店管理   | `LqMdxxService`、`LqMdXdbhsjService` |
  | 人员/金三角 | `LqYcsdJsjService`、金三角用户绑定相关服务 |
  | 客户管理   | `LqKhxxService`、`LqTkjlbService`、`LqEventService` |
  | 工具       | `EmailService`、`DocumentService`、`BigDataService`、`WorkLogService` |
bdf9e891   “wangming”   更新.gitignore以包含.z...
164
  
ba386929   “wangming”   docs: update READ...
165
  实体与 DTO 在 `NCC.Extend.Entitys`(Entity、Dto、Mapper、Model)。
bdf9e891   “wangming”   更新.gitignore以包含.z...
166
  
ba386929   “wangming”   docs: update READ...
167
  ---
bdf9e891   “wangming”   更新.gitignore以包含.z...
168
  
ba386929   “wangming”   docs: update READ...
169
  ## 开发规范
df137fbd   “wangming”   更新README.md,完善项目介...
170
  
ba386929   “wangming”   docs: update READ...
171
  完整规范见 **[PROJECT_RULES.md](./PROJECT_RULES.md)**(或仓库内 `.cursor/rules/project_rules.mdc`),开发前请阅读。要点包括:
df137fbd   “wangming”   更新README.md,完善项目介...
172
  
ba386929   “wangming”   docs: update READ...
173
174
175
  - **后端**:ID 使用 `YitIdHelper.NextId().ToString()`;分层 Entitys → Interfaces → Services;关键方法写 XML 注释;统一异常与返回格式。
  - **前端**:GET 请求用 `data` 传参;表格用 NCC-table;弹窗/二级页单独组件;文件命名 kebab-case。
  - **数据**:统计与列表使用相同筛选条件;涉及人员/门店归属等见「已弃用表」说明,使用约定表与字段。
df137fbd   “wangming”   更新README.md,完善项目介...
176
  
ba386929   “wangming”   docs: update READ...
177
  ---
df137fbd   “wangming”   更新README.md,完善项目介...
178
  
ba386929   “wangming”   docs: update READ...
179
  ## 部署
df137fbd   “wangming”   更新README.md,完善项目介...
180
  
ba386929   “wangming”   docs: update READ...
181
182
  - **后端**`dotnet publish -c Release`,配置生产环境连接字符串,部署至 IIS 或 Linux。
  - **前端**`npm run build`,将 `antis-ncc-admin/dist` 部署至 Web 服务器,并配置反向代理(如 Nginx)指向后端 API。
df137fbd   “wangming”   更新README.md,完善项目介...
183
  
ba386929   “wangming”   docs: update READ...
184
  ---
df137fbd   “wangming”   更新README.md,完善项目介...
185
  
ba386929   “wangming”   docs: update READ...
186
  ## 常见问题
df137fbd   “wangming”   更新README.md,完善项目介...
187
  
ba386929   “wangming”   docs: update READ...
188
189
190
191
192
193
  | 问题               | 处理建议 |
  |--------------------|----------|
  | 前端启动失败       | 确认 Node.js 为 16.20.2(`nvm use 16.20.2` 或安装该版本)。 |
  | 后端连不上数据库   | 检查 `appsettings.json` 连接字符串及 MySQL 服务是否启动。 |
  | 权限/Token 报错    | 检查 JWT 配置与 Token 有效期。 |
  | 统计类 SQL 报错    | 先用 MCP MySQL 工具验证 SQL 语法与表名字段名。 |
d8035736   “wangming”   Refactor project ...
194
  | 脚本无法执行      | 执行 `chmod +x 项目文档相关/scripts/sh/*.sh`。 |
bdf9e891   “wangming”   更新.gitignore以包含.z...
195
196
197
  
  ---
  
ba386929   “wangming”   docs: update READ...
198
199
200
  ## 许可证与说明
  
  本项目仅供学习与内部使用,请勿用于商业用途。  
d8035736   “wangming”   Refactor project ...
201
  技术问题可先查阅 `项目文档相关/docs/` 与 `PROJECT_RULES.md`,或联系开发团队。