README.md
悟空CRM-11.0
悟空CRM介绍
悟空CRM在中国的开源管理软件行业有较高的知名度。目前软件已达到千万级的用户量，开源系统下载量达到200多万次，已覆盖设计制造业、服务业、金融业、政府机构等多种行业。与阿里巴巴、腾讯、OPPO、航天信息、CCTV等多家知名企业达成战略合作。
公司先后获得河南省高新技术企业、国家3A信用企业、IOS9001、IOS27001软件产品认证等20多项荣誉奖项。拥有50余项软件著作权。 获得20余家国内媒体报道。公司自成立以来，以高科技为起点，以技术为核心、 以完善的售后服务为后盾，秉承稳固与发展、求实与创新的精神，已为国内外上万家企业提供了服务。 在为实现企业价值最大化的过程中， 实现了自身的价值的提升，取得了最大程度的双赢合作，并获得了社会各界的广泛赞誉和认同。
官网地址：http://www.5kcrm.com
演示地址：(https://demo10.72crm.com/#/crm)
帐号：18688888888 密码：123456a
码云地址：https://gitee.com/wukongcrm
QQ群交流群群：1026560336
扫码添加小悟官方客服微信，邀您加入千人微信交流群：
关注悟空CRM公众号，了解更多悟空资讯
(点击下载前端代码)
悟空CRM目录结构
wk_crm
├── admin -- 系统管理模块和用户管理模块
├── authorization -- 鉴权模块，目前仅用于登录鉴权，后期可能有更改
├── bi -- 商业智能模块
├── core -- 通用的代码和工具类
├── crm -- 客户管理模块
├── examine -- 审批模块
├── gateway -- 网关模块
├── job -- 定时任务模块
├── oa -- OA模块
└── work -- 项目管理模块
悟空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项目架构图
使用说明
一、前置环境
- Jdk1.8
- Maven3.5.0+
- Mysql5.7.20 （数据库安装注意事项）
- Redis(版本不限)
- Elasticsearch 6.8.6 （环境配置注意事项）
- Seata（1.2.0）（配置说明）
- Sentinel（1.7.2）（项目中sentinel使用8079端口）
- Nacos（1.2.1)
安装
一键安装说明
本项目支持Docker一键安装（建议配置 4核16G以以上），查看具体安装方法
常见问题
手动安装说明
1. 导入初始化sql,目前项目下gateway模块使用的独立数据库，其他模块使用同一数据库
- 安装nacos，新建数据库
nacos在nacos数据库中运行DB/nacos.sql
修改nacos安装目录/conf/application.properties文件，修改数据持久化类型为mysql，添加mysql数据源的url、用户名和密码,配置如下。
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 配置注意点
5.（可选）修改系统中文件上传地址，默认为本地配置，本地上传还需配置公网地址，指向服务器网关
crm.upload.config:1 文件上传配置 1:本地 2:阿里云OSS
crm.upload.oss oss上传文件所需配置内容
crm.upload.oss.bucketName 需要配置两个bucket，0为登录才可访问文件上传地址，1为完全公开文件上传地址
crm.upload.local 本地上传文件所需配置内容
crm.upload.local.uploadPath 需要配置两个地址0为登录才可访问文件上传地址，1为完全公开文件上传地址6.（可选）修改jetcache缓存配置详见 官方文档
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. 项目启动
先启动nacos,seata,sentinel, elasticsearch,mysql,redis等基础服务
在第八步解压的文件模块下通过执行`sh 72crm.sh start`（windows下直接运行72crm.bat）启动各个模块服务。
其中项目基础模块：gateway，authorization，admin必须启动，其他模块可按需启动。
启动完成后，在浏览器中访问：http://localhost:8443/即可登录系统
10. 初始化用户信息
访问http://localhost:8443/
按照提示初始化超级管理员账号和密码信息，成功之后使用初始化后的管理员账户登录系统添加其他员工，分配权限等
11. 升级说明以及注意事项
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.代码生成器及接口文档
代码生成器地址：core\src\test\com\kakarote\generator\Generator.java
接口文档地址`http://localhost:8443/doc.html`
2.模块依赖关系
- 除网关外，其余项目均依赖于admin模块，用于获取当前登录人的信息
- oa模块的任务依赖于work模块，其余一些关联业务功能依赖于crm模块，examine模块
- 商业智能依赖crm,oa模块
3.更新日志
四、悟空CRM功能模块预览
