克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

wk_crm

介绍

悟空软件长期为企业提供企业管理软件(CRM/HRM/OA/ERP等)的研发、实施、营销、咨询、培训、服务于一体的信息化服务。悟空软件以高科技为起点,以技术为核心、以完善的售后服务为后盾,秉承稳固与发展、求实与创新的精神,已为国内外上千家企业提供服务。

悟空的发展受益于开源,也会回馈于开源。2020年,悟空CRM会继续秉承“拥抱开放、合作共赢、创造价值”的理念,在开源的道路上继续砥砺前行,和更多的社区开发者一起为国内外开源做出积极贡献。

目录结构

wk_crm
├── admin         -- 系统管理模块和用户管理模块
├── authorization -- 鉴权模块,目前仅用于登录鉴权,后期可能有更改
├── bi            -- 商业智能模块
├── core          -- 通用的代码和工具类
├── crm           -- 客户管理模块
├── email         -- 邮箱模块
├── gateway       -- 网关模块
├── job           -- 定时任务模块
├── km            -- 定时任务模块
├── oa            -- OA模块
└── work          -- 项目管理模块


主要技术栈

名称 版本 说明
spring-cloud-alibaba 2.2.1.RELEASE(Hoxton.SR3) 核心框架
swagger 2.9.2 接口文档
mybits-plus 3.3.0 ORM框架
sentinel 2.2.1.RELEASE 断路器以及限流
nacos 2.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 服务调用

项目架构图

项目架构图

使用说明

一、 前置环境

  • Jdk1.8
  • Maven3.5.0+
  • Mysql5.7.20 (注意事项
  • Redis(版本不限)
  • Elasticsearch 6.8.6 (注意事项
  • Seata(1.2.0)
  • Sentinel(1.7.2)
  • Nacos(1.2.1)

二、 安装说明

- 导入初始化sql,目前项目下gateway使用的独立数据库,其他模块暂时用的是同一数据库,后续可能进行拆分
  

     1、初始化gateway模块               导入 DB/config_info_route.sql
     4、初始化其余模块                  导入 DB/wk_crm.sql
     5、初始化定时任务模块              导入 DB/xxl_job.sql


- 在项目根目录执行mvn install
- 然后在各个项目修改数据库以及redis配置文件,默认使用的是application-dev.yml,打包后启动脚本默认使用的application-test.yml配置
- 在core\src\main\resources\application-core.yml里面
  修改elasticsearch配置

    spring.elasticsearch.rest.uris = elasticsearch地址 例:127.0.0.1:9200
    spring.elasticsearch.rest.username = elasticsearch用户名 例:elastic
    spring.elasticsearch.rest.password = elasticsearch用户名 例: password 

  修改文件上传地址
    crm.upload.config = 文件上传配置 1 本地 2 阿里云OSS 例 :1
    crm.upload.oss  oss上传文件所需配置内容 crm.upload.oss.bucketName 需要配置两个bucket,
                    0为登录才可访问文件上传地址,1为完全公开文件上传地址
    crm.upload.oss  本地上传文件所需配置内容 crm.upload.oss.uploadPath 需要配置两个地址
                    0为登录才可访问文件上传地址,1为完全公开文件上传地址
                    本地还需配置公网地址,指向服务器网关
  修改jetcache缓存配置
        详见 https://github.com/alibaba/jetcache/wiki
- 项目日志文件在core\src\main\resources\logback-spring.xml修改
  1. 启动
    - 先启动nacos,seata,sentinel, elasticsearch,mysql,redis等基础服务

    • 再启动各个服务,最少需要启动的服务(gateway,authorization,admin)
      • 初始化其他依赖框架配置
        1、修改seata配置详见,详见 2、修改xxl-job配置,详见初始化xxl-job
  2. 打包部署
    ·在项目根目录下执行 mvn clean -Dmaven.test.skip=true package
    ·然后把对应项目下target文件夹下
    ·${name}-${version}-SNAPSHOT.zip/tar.gz上传到服务器,如 admin-0.0.1-SNAPSHOT.zip
    ·将压缩文件解压,执行sh 72crm.sh start,windows下直接运行72crm.bat
    ·项目启动默认使用的application-test.yml,application-core.yml,如需修改,可修改对应脚本文件,如:
    ·spring.profiles.include=core,prod

  3. 其他说明

    • 代码生成器在core\src\test下,core\src\test\com\kakarote\generator\Generator.java

    • 接口文档地址 http://localhost:8443/swagger-ui.html 或者访问对应服务下 http://服务地址:端口/swagger-ui.html

    • crm初次启动需要初始化elasticsearch索引库
      初始化方法为:
      开启crm服务
      然后直接通过浏览器访问 网关地址/crmField/initData?type=?
      如: http://localhost:8443/crmField/initData?type=1
      type取值为 1:线索,2: 客户,3:联系人,4:产品,5: : 商机,6:合同,7:回款,9::公海,17:回访
      第一次启动不需要初始化公海模块
      以后因数据迁移等需要重新操作可以重新调用本接口进行初始化
      初始化前需要去elasticsearch删除对应索引
      项目部署到正式环境建议此方法删除或加密
      Elasticsearch只是保存了数据库的一个副本方便查询,所有数据以数据库为准

  4. 模块依赖关系

    除网关外,其余项目均依赖于admin模块 ,用于获取当前登录人的信息
    oa模块的任务依赖于work模块,其余一些关联业务功能依赖于crm模块
    商业智能依赖crm,oa模块

三、 功能预览

截图截图

四、xxxx> 这里输入引用文本

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

悟空CRM 展开 收起
Java
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化