crm_pro-master/README.md

280 lines
13 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 悟空CRM-11.0
**最新资讯: :collision: 悟空CRM云服务完全免费且不限人数。悟空云正式上线包含客户关系管理系统CRM人力资源管理系统CRM、财务管理系统FS、无代码平台、SCRM**
体验地址:[https://www.72crm.com](http://www.72crm.com)
## 悟空CRM介绍
悟空CRM在中国的开源管理软件行业有较高的知名度。目前软件已达到千万级的用户量开源系统下载量达到200多万次已覆盖设计制造业、服务业、金融业、政府机构等多种行业。与阿里巴巴、腾讯、OPPO、航天信息、CCTV等多家知名企业达成战略合作。
公司先后获得河南省高新技术企业、国家3A信用企业、IOS9001、IOS27001软件产品认证等20多项荣誉奖项。拥有50余项软件著作权。 获得20余家国内媒体报道。公司自成立以来以高科技为起点以技术为核心、 以完善的售后服务为后盾,秉承稳固与发展、求实与创新的精神,已为国内外上万家企业提供了服务。 在为实现企业价值最大化的过程中, 实现了自身的价值的提升,取得了最大程度的双赢合作,并获得了社会各界的广泛赞誉和认同。
官网地址:[http://www.5kcrm.com](http://www.5kcrm.com/)
演示地址:(https://demo10.72crm.com/#/crm)
帐号18688888888 密码123456a
Github下载地址[https://github.com/72wukong](https://github.com/72wukong)
QQ群交流群群[259359511](https://qm.qq.com/cgi-bin/qm/qr?k=G9T2audQqbZBR_HG0aTP9E-8fE7oMeb8&jump_from=webapi)
扫码添加小悟官方客服微信,邀您加入千人微信交流群:
<img src="https://images.gitee.com/uploads/images/2019/1231/115927_f9c580c8_345098.png" width="200">
关注悟空CRM公众号了解更多悟空资讯
<img src="https://images.gitee.com/uploads/images/2019/1202/135713_d3566c6a_345098.jpeg" width="200">
:boom: :boom: :boom: 注悟空CRM采用全新的前后端分离模式本仓库代码中已集成前端vue打包后文件 **可免去打包操作,无需运行前端** 。如需调整前端代码,请单独下载前端代码
(<a href="https://gitee.com/wukongcrm/W72crm_web" target="_blank">点击下载前端代码</a>)
## 悟空CRM目录结构
``` lua
wk_crm
├── admin -- 系统管理模块和用户管理模块
├── authorization -- 鉴权模块,目前仅用于登录鉴权,后期可能有更改
├── bi -- 商业智能模块
├── core -- 通用的代码和工具类
├── crm -- 客户管理模块
├── examine -- 审批模块
├── gateway -- 网关模块
├── job -- 定时任务模块
├── oa -- OA模块
└── work -- 项目管理模块
└── hrm -- 人力资源管理模块
```
### 核心功能模块
CRM/OA功能<br/>
客户管理:客户数据录入,支持数据查重,数据转移<br/>
线索管理:支持线索转化客户<br/>
客户池管理:可配置多个客户池,根据成交等多种条件设置回收规则<br/>
商机管理:支持设置多个商机,商机阶段自定义配置<br/>
合同管理:合同审批流配置<br/>
回款管理:回款审核、审批流配置<br/>
办公审批:支持配置审批流(请假、报销、借款、出差等自定义配置)<br/>
日程/任务:支持任务分配、任务<br/><br/>
人力资源功能:<br/>
招聘管理:支持候选人添加、筛选、面试管理<br/>
人员管理:多维度组织架构配置<br/>
薪酬管理:可以灵活配置薪酬类型<br/>
社保管理:支持全国不同地区社保配置<br/>
绩效考核灵活配置绩效考核流程支持OKR和KPI绩效考核模板<br/><br/>
员工端:<br/>
员工自助查询个人信息、薪酬信息、社保信息、绩效考核信息<br/><br/>
系统配置:<br/>
系统自定义字段配置<br/>
审批流配置<br/>
员工组织架构配置<br/>
角色权限配置(精确到字段权限)<br/>
日志配置<br/>
公海规则配置<br/>
业务参数配置<br/>
初始化数据配置<br/>
其他配置<br/>
## 悟空CRM使用的主要技术栈
| 名称 | 版本 | 说明 |
|---------------------|---------------------------|----|
| spring-cloud-alibaba| 2.2.1.RELEASE(Hoxton.SR3) | 核心框架 |
| swagger | 2.9.2 | 接口文档 |
| mybatis-plus | 3.3.0 | ORM框架 |
| sentinel | 2.2.1.RELEASE | 断路器以及限流 |
| nacos | 1.2.1.RELEASE | 注册中心以及分布式配置管理 |
| seata | 1.2.0 | 分布式事务 |
| elasticsearch | 2.2.5.RELEASE(6.8.6) | 搜索引擎中间件 |
| jetcache | 2.6.0 | 分布式缓存框架 |
| xxl-job | 2.1.2 | 分布式定时任务框架 |
| gateway | 2.2.2.RELEASE | 微服务网关 |
| feign | 2.2.2.RELEASE | 服务调用 |
## 悟空CRM项目架构图
<img src="https://images.gitee.com/uploads/images/2020/0910/094237_e7cb3bca_1096736.jpeg" width="650">
## 使用说明
### 一、前置环境
- Jdk1.8
- Maven3.5.0+
- Mysql5.7.20 <a href="https://gitee.com/wukongcrm/crm_pro/wikis/mysql配置说明" target="_blank">数据库安装注意事项</a>
- Redis(版本不限)
- Elasticsearch 6.8.6 <a href="https://gitee.com/wukongcrm/crm_pro/wikis/elasticsearch配置说明" target="_blank">环境配置注意事项</a>
- Seata1.2.0<a href="https://gitee.com/wukongcrm/crm_pro/wikis/seata" target="_blank">配置说明</a>
- Sentinel1.7.2项目中sentinel使用8079端口
- Nacos1.2.1)
### 安装
### 一键安装说明
本项目支持Docker一键安装建议配置 4核16G以以上[查看具体安装方法](https://gitee.com/wukongcrm/crm_pro/wikis/Docker一键安装教程?sort_id=3033975)
**CentOS7手动安装教程参考** [wiki](https://gitee.com/wukongcrm/crm_pro/wikis/CentOS7安装悟空CRM教程)
### 常见问题
<a href="https://bbs.72crm.com/portal.php?fid=44" target="_blank">常见问题以及解决方案</a>
### 手动安装说明
#### 1. 导入初始化sql,目前项目下gateway模块使用的独立数据库其他模块使用同一数据库
- 安装nacos新建数据库 `nacos` 在`nacos`数据库中运行` DB/nacos.sql`<br/>
修改nacos安装目录/conf/application.properties文件修改数据持久化类型为mysql添加mysql数据源的url、用户名和密码,配置如下。<br/>
```
spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=password
```
- 修改gateway模块数据库配置为`nacos`数据库
- 初始化其余模块数据库:新建数据库 `wk_crm_single` 在`wk_crm_single`数据库中运行 `DB/wk_crm_single.sql`
- 初始化定时任务模块数据库:新建数据库 `xxl_job` 在`xxl_job`数据库中运行 `DB/xxl_job.sql`
- 初始化seata数据库新建数据库 `seata` 在`seata`数据库中运行 `DB/seata.sql`
#### 2.在项目根目录执行`mvn install`
#### 3.在各个模块下resource目录配置数据库帐号信息以及redis帐号信息`默认使用的是application-dev.yml配置文件,打包后启动脚本默认使用的application-test.yml配置文件`
#### 4.在`crm\src\main\resources\application-dev.yml`里面修改elasticsearch配置
```
spring.elasticsearch.rest.uris = elasticsearch地址 例127.0.0.1:9200
spring.elasticsearch.rest.username = elasticsearch用户名 例elastic 无密码可留空
spring.elasticsearch.rest.password = elasticsearch密码 例: password 无密码可留空
```
注意elasticsearch [配置注意点](https://gitee.com/wukongcrm/crm_pro/wikis/elasticsearch配置说明?sort_id=2927431)
#### 5.(可选)修改系统中文件上传地址,默认为本地配置,本地上传还需配置公网地址,指向服务器网关
```
crm.upload.config:1 文件上传配置 1:本地 2:阿里云OSS
crm.upload.oss oss上传文件所需配置内容
crm.upload.oss.bucketName 需要配置两个bucket0为登录才可访问文件上传地址1为完全公开文件上传地址
crm.upload.local 本地上传文件所需配置内容
crm.upload.local.uploadPath 需要配置两个地址0为登录才可访问文件上传地址1为完全公开文件上传地址
```
#### 6.可选修改jetcache缓存配置详见 <a href="https://github.com/alibaba/jetcache/wiki" target="_blank">官方文档</a>
#### 7.(可选)项目日志文件在`core\src\main\resources\logback-spring.xml`修改
#### 8. 项目打包部署
```
·在项目根目录下执行 mvn clean -Dmaven.test.skip=true package
·然后把对应模块下target文件夹下
·${name}-${version}-SNAPSHOT.zip/tar.gz上传到服务器,例admin-0.0.1-SNAPSHOT.zip 并将压缩文件解压,检查对应配置文件。
```
#### 9. 项目启动 <br/>
```
先启动nacos,seata,sentinel, elasticsearch,mysql,redis等基础服务
在第八步解压的文件模块下通过执行`sh 72crm.sh start`windows下直接运行72crm.bat启动各个模块服务。
其中项目基础模块gatewayauthorizationadmin必须启动其他模块可按需启动。
启动完成后在浏览器中访问http://localhost:8443/即可登录系统
```
#### 10. 初始化用户信息(序列号)<br/>
```
访问http://localhost:8443/
按照提示初始化超级管理员账号和密码信息,其中序列号填写,成功之后使用初始化后的管理员账户登录系统添加其他员工,分配权限等
激活序列号:
6EA74C261C4BA344BC716FCD68295694BABFE016F5B7FA4890E4E29B0F52A5D965EE4A1AF633633D4573A2559630986F976D8F2920D688686CB60967F6FFB9FDADE6AC6DFD39416DE175D0DE01699C816244C16EE4E533A959E3ED0653143A7363E5B98E62126A78CDC5578636F456D29FD2B063FCBED837D50B10450C6FFBF0290DB782C8D4525864A96A98C37C0106FB5D8392A7E828F0BEFA86B4CD28BEBE83628A59BB23F60B7799A22C8D7B2039ED30F05492E9D2A2E2A03D7AC0199EA2CE529D561AE622B3C0DECC50D8A223BC5DA03E3AFF1150F0F217B0BE0400835369329DB74454870D5314DBA7C24B98CCE5600CBDAF264A21974FA3C85E7EAF0A
```
#### 11. 升级说明以及注意事项<br/>
```
1、后端代码更新直接下载全量代码替换即可
2、数据库更新请下载 DB/update/V11.x.x.sql增量执行即可比如当前版本为V11.0.1升级为V11.1.0需执行 V11.0.2.sql,V11.1.0.sql
3、docker更新请使用在线更新或手动将数据库数据备份后执行增量升级SQL再备份至本地然后下载新版docker镜像将增量升级后SQL恢复至新版数据库
```
### 三、其他说明
#### 1.代码生成器及接口文档<br/>
```
代码生成器地址core\src\test\com\kakarote\generator\Generator.java
接口文档地址`http://localhost:8443/doc.html`
```
#### 2.模块依赖关系 <br/>
```
- 除网关外其余项目均依赖于admin模块用于获取当前登录人的信息
- oa模块的任务依赖于work模块其余一些关联业务功能依赖于crm模块examine模块
- 商业智能依赖crm,oa模块
```
#### 3.更新日志<br/>
<a href="https://www.72crm.com/upgrade_log" target="_blank">点击查看更新日志</a>
<br/>
### 四、悟空CRM功能模块预览
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172541_efed65bd_345098.png "01.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172557_c001d047_345098.png "02.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172612_97363074_345098.png "03.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172625_47a2798b_345098.png "04.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172636_ae5cad59_345098.png "05.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172648_c7928c60_345098.png "06.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172704_ac4c3308_345098.png "07.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172714_84b7ee29_345098.png "08.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172726_4552bddb_345098.png "10.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172736_da77deec_345098.png "11.png")
![输入图片说明](https://images.gitee.com/uploads/images/2020/0928/172745_e22b7a4a_345098.png "12.png")