作者 陈志颖

docs:更新README

正在显示 1 个修改的文件 包含 54 行增加24 行删除
1 # 价值系统后台管理服务 1 # 价值系统后台管理服务
  2 +项目使用框架
  3 + - http框架:beego
  4 + - orm框架:go-pg
  5 + - 数据存储:postgresql
  6 + - 项目结构分层:基于端口适配器架构(六边形架构)实现领域驱动设计(DDD领域驱动)
  7 +
2 项目目录结构 8 项目目录结构
3 ``` 9 ```
4 ├─conf 项目配置文件 10 ├─conf 项目配置文件
5 ├─deploy 项目部署文件 11 ├─deploy 项目部署文件
6 - ├─document 接口文档(导入yapi)  
7 - ├─test 业务接口自动化测试 12 + ├─document 接口文档
  13 + ├─test 业务接口集成测试
8 ├─pkg 14 ├─pkg
9 - │ ├─application 应用层(薄层)  
10 - │ │ ├─employee 企业员工  
11 - │ │ ├─task 任务(状态机) 15 + │ ├─application 应用层
  16 + │ │ ├─employee 员工
  17 + │ │ ├─task 任务
12 │ │ ├─suMoney 素币 18 │ │ ├─suMoney 素币
13 │ │ ├─statistics 统计 19 │ │ ├─statistics 统计
14 - │ │ ├─notification 消息通知  
15 - │ │ ├─customerValue 客户价值(任务配置项)  
16 - │ │ ├─projectBelong 项目归属(任务配置项)  
17 - │ │ ├─taskNature 任务性质(任务配置项)  
18 - │ │ ├─unifiedUserCenter 统一用户中心适配(用于同步员工账户信息) 20 + │ │ ├─notification 消息通知
  21 + │ │ ├─customerValue 客户价值
  22 + │ │ ├─projectBelong 项目归属
  23 + │ │ ├─taskNature 任务性质
  24 + │ │ ├─unifiedUserCenter 统一用户中心适配
19 │ │ ├─event 注册领域业务事件订阅以及处理 25 │ │ ├─event 注册领域业务事件订阅以及处理
20 - │ │ └─factory 工厂类(工厂方法,用于组装复杂对象或者聚合) 26 + │ │ └─factory 工厂类,组装复杂对象或者聚合
21 │ ├─domain 领域层(核心业务逻辑建模,实体,聚合根) 27 │ ├─domain 领域层(核心业务逻辑建模,实体,聚合根)
22 - │ │ ├─event/  
23 - │ │ ├─service/ 领域层服务(非CURD类型的特殊操作)  
24 - │ │ ├─domain... 领域模型(具体的模型类实现)  
25 - │ │ └─task 任务状态机实现  
26 - │ ├─infrastructure 基础设施层  
27 - │ │ ├─dao 数据库操作(数据访问对象)  
28 - │ │ ├─domain_service 领域服务数据库操作(支持领域的基础设施层服务)  
29 - │ │ ├─pg postgresql 数据库模型定义  
30 - │ │ ├─repository 实体或者聚合根模型仓储(对应domain定义的仓储接口)  
31 - │ │ └─service_gateway 服务网关,其他业务接口或者第三方服务接口网关(微服务)  
32 - │ ├─constant 变量配置(数据库等) 28 + │ │ ├─event/ 领域事件
  29 + │ │ ├─service/ 领域服务
  30 + │ │ ├─domain... 领域对象
  31 + │ │ └─task 任务状态机实现
  32 + │ ├─infrastructure 基础设施层
  33 + │ │ ├─dao 数据访问对象
  34 + │ │ ├─domain_service 领域服务具体实现
  35 + │ │ ├─pg 数据模型定义
  36 + │ │ ├─repository 实体或者聚合根模型仓储
  37 + │ │ └─service_gateway 微服务网关,其他业务接口或者第三方服务接口网关
  38 + │ ├─constant 项目配置常量设置
33 │ ├─log 日志模块 39 │ ├─log 日志模块
34 - │ └─port 端口 40 + │ └─port 用户接入
35 │ └─beego beego框架接入实现http接口 41 │ └─beego beego框架接入实现http接口
36 - └─logs 42 + └─logs 日志文件
37 ``` 43 ```
  44 +
  45 +主要业务模块
  46 + - 企业员工模块(application/employee)
  47 + - 素币模块(application/suMoney)
  48 + - 任务模块(application/task)
  49 + - 统计模块(application/statistics)
  50 + - 消息通知模块(application/notification)
  51 + - 适配统一用户中心模块(application/unifiedUserCenter)
  52 +
  53 +# 安装与使用
  54 +[价值系统代码仓库地址](http://gitlab.fjmaimaimai.com/linmadan/mmm-worth)
  55 +
  56 +新建开发分支,如:xxx-dev,下载相应分支代码
  57 +```
  58 +git clone -b xxx-dev http://gitlab.fjmaimaimai.com/linmadan/mmm-worth.git
  59 +```
  60 +安装项目依赖:
  61 +```
  62 +go mod tidy
  63 +```
  64 +启动项目
  65 +```
  66 +bee run
  67 +```