更新文档

README.md

@@ -1,11 +1,22 @@
-## zheng
+# zheng
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/shuzheng/zheng/pulls)
 [![GitHub forks](https://img.shields.io/github/forks/shuzheng/zheng.svg?style=social&label=Fork)](https://github.com/shuzheng/zheng)
 
 交流QQ群：133107819
 
-# 项目组织结构
+文档：[https://shuzheng.gitbooks.io/zheng/content/](https://shuzheng.gitbooks.io/zheng/content/ "文档")
+
+## 前言
+
+　　`zheng`项目于2016年10月4日创建于Github，之初目的是为自己建立一个“小工具”，后因github网速慢的原因同步到oschina上，迅速得到国内广大同仁关注、支持和肯定，所以我也愿意分享给大家使用。最近经常收到一些提问，由于缺乏文档，虽然耐心解答，但杯水车薪，特开始篡写文档并建立交流群等。
+
+## 项目组织结构
+
+基于Spring+SpringMVC+Mybatis分布式敏捷开发系统架构：内容管理系统（门户、博客、论坛、问答等）、统一支付中心（微信、支付宝、在线网银等）、用户权限管理系统（RBAC细粒度用户权限、统一后台、单点登录、会话管理）、微信管理系统、第三方登录系统、会员系统、存储系统等
+
+### 组织结构
+
 ``` lua
 zheng
 ├── zheng-common -- 公共模块
@@ -49,10 +60,9 @@ zheng
      └── zheng-oss-web -- 管理界面[端口:7771]
 ```
 
-# 项目模块结构图
-![项目模块结构图](project-bootstrap/project.png)
+### 技术选型
 
-# 后端技术:
+#### 后端技术:
 * Spring Framework
 * SpringMVC: MVC框架
 * Spring secutity|Shiro: 安全框架
@@ -78,7 +88,7 @@ zheng
 * Jenkins: 持续集成工具
 * Maven|Gradle: 项目构建管理
 
-# 前端技术:
+#### 前端技术:
 * jQuery
 * Bootstrap
 * jQuery EasyUI
@@ -88,7 +98,68 @@ zheng
 * zheng.jprogress.js [一款模仿youtube加载进度条插件](https://github.com/shuzheng/zheng.jprogress.js "zheng.jprogress.js")
 * zheng.jtotop.js [返回顶部插件(可以任意速度滑动到指定任意位置)](https://github.com/shuzheng/zheng.jtotop.js "zheng.jtotop.js")
 
-# 开发工具:
+#### 模块依赖
+![模块依赖](project-bootstrap/project.png)
+
+#### 模块介绍
+
+##### zheng-common
+
+Spring+SpringMVC+Mybatis框架集成公共模块，包括公共配置、MybatisGenerator扩展插件、通用BaseService、工具类等。
+
+##### zheng-admin
+
+基于bootstrap实现的响应式Material Design风格的通用后台管理系统，`zheng`项目所有系统都是使用该模块界面作为前端展示。
+
+##### zheng-upms
+
+本系统是基于RBAC授权和基于用户授权的细粒度权限控制通用平台，并提供单点登录、会话管理和日志管理。接入的系统可自由定义组织、角色、权限、资源等。
+
+**系统功能概述：**
+
+- 系统组织管理：系统和组织增加、删除、修改、查询功能。
+- 用户角色管理：用户和角色增加、删除、修改、查询功能。
+- 资源权限管理：资源和权限增加、删除、修改、查询功能。
+- 权限分配管理：提供给角色和用户的权限增加、删除、修改、查询功能。
+- 单点登录(SSO)：提供统一用户单点登录认证、用户鉴权功能。
+- 用户会话管理：提供分布式用户会话管理
+- 操作日志管理：提供记录用户登录、操作等日志。
+
+##### zheng-oss
+
+文件存储系统，提供三种方案：
+
+- **阿里云** 对象存储OSS
+- **腾讯云** 对象存储COS
+- **七牛云** 对象存储
+
+##### zheng-api
+
+接口系统，包括开发加密接口、接口文档等对外开放服务。
+
+##### zheng-cms
+
+内容管理系统：支持多标签、多类目、强大评论的内容管理，有基本单页展示，菜单管理，系统设置等功能。
+
+##### zheng-pay
+
+一站式支付解决方案，统一下单接口，支持支付宝、微信、网银等多种支付方式。不涉及业务的纯粹的支付平台。
+
+**功能介绍：**
+
+- 统一下单（统一下单接口、统一扫码）、订单管理、数据分析、财务报表、商户管理、渠道管理、对账系统、系统监控
+
+##### zheng-ucenter
+
+通用用户管理系统， 实现最常用的用户注册、登录、资料管理、个人中心、第三方登录等基本需求，支持扩展二次开发。
+
+##### zheng-wechat-mp
+
+微信公众号管理平台，除实现官网后台自动回复、菜单管理、素材管理、用户管理、消息群发等基础功能外，还有二维码推广、营销活动、微网站、会员卡、优惠券等
+
+## 环境搭建
+
+#### 开发工具:
 * MySql: 数据库
 * jetty: 开发服务器
 * Tomcat: 应用服务器
@@ -99,34 +170,21 @@ zheng
 * PowerDesigner: 建模工具
 * Navicat for MySQL: 数据库客户端
 
-# 项目使用方法
-
-
-### 开发环境搭建:
-
-* 前提：本机安装Jdk7、Mysql、Redis、Zookeeper、ActiveMQ并启动相关服务，使用默认配置默认端口，下面有资源下载链接（安装流程略）
-
-* 克隆源代码到本地并打开，推荐使用IntelliJ IDEA，本地编译并安装到本地maven仓
-
-### 编译流程
-
-* zheng-admin、zheng-common => zheng-oss、zheng-api => zheng-upms => 其他
+#### 开发环境：
 
-### 开发流程
+- Jdk7
+- Mysql5.5
+- Redis
+- Zookeeper
+- ActiveMQ
+- Dubbo-admin
 
-- 创建数据表（建议使用PowerDesigner）
-
-- 直接运行对应项目dao模块中的generator.main()，可自动生成单表的CRUD功能和对应的model、example、mapper、service代码
+### 工具安装
 
-    - 生成的model和example均已实现Serializable接口，支持分布式
-    - 生成的mapper.xml的selectByExample方法自动包含分页参数offset和limit
-    - 已包含抽象类BaseServiceImpl，只需要继承抽象类并传入泛型参数，即可默认实现mapper接口所有方法，特殊需求直接扩展即可
+整理中...
 
-- 启动流程：优先rcp-service服务提供者，再启动其他webapp
+### 资源下载
 
-- 扩展流程：可扩展和拆分rpc-api和rpc-service模块，可按微服务拆分或场景拆分
-
-### 资源下载链接
 * JDK7 [http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html#jdk-7u80-oth-JPR](http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html#jdk-7u80-oth-JPR "JDK7")
 * Maven [http://maven.apache.org/download.cgi](http://maven.apache.org/download.cgi "Maven")
 * Redis [https://redis.io/download](https://redis.io/download "Redis")
@@ -137,6 +195,16 @@ zheng
 * dubbo-admin-2.5.3 [http://download.csdn.net/detail/shuzheng5201314/9733652](http://download.csdn.net/detail/shuzheng5201314/9733652 "dubbo-admin-2.5.3")
 * dubbo-admin-2.5.4-SNAPSHOT-jdk8 [http://download.csdn.net/detail/shuzheng5201314/9733657](http://download.csdn.net/detail/shuzheng5201314/9733657 "dubbo-admin-2.5.4-SNAPSHOT-jdk8")
 
+
+# 项目使用方法
+
+
+## 开发指南:
+
+* 1、本机安装Jdk7、Mysql、Redis、Zookeeper、ActiveMQ并启动相关服务，使用默认配置默认端口，下面有资源下载链接（安装流程略）
+
+* 2、克隆源代码到本地并打开，**推荐使用IntelliJ IDEA**，本地编译并安装到本地maven仓
+
 ### 修改本地Host
 * 127.0.0.1	upms.zhangshuzheng.cn
 * 127.0.0.1	cms.zhangshuzheng.cn
@@ -146,11 +214,37 @@ zheng
 * 127.0.0.1	api.zhangshuzheng.cn
 * 127.0.0.1	oss.zhangshuzheng.cn
 
-# 预览图
+### 编译流程
+
+zheng-admin、zheng-common => zheng-oss、zheng-api => zheng-upms => 其他
+
+### 开发演示
+
+- 创建数据表（建议使用PowerDesigner）
+
+- 直接运行对应项目dao模块中的generator.main()，可自动生成单表的CRUD功能和对应的model、example、mapper、service代码
+
+    - 生成的model和example均已实现Serializable接口，支持分布式
+    - 生成的mapper.xml的selectByExample方法自动包含分页参数offset和limit
+    - 已包含抽象类BaseServiceImpl，只需要继承抽象类并传入泛型参数，即可默认实现mapper接口所有方法，特殊需求直接扩展即可
+
+- 启动流程：优先rcp-service服务提供者，再启动其他webapp
+
+- 扩展流程：可扩展和拆分rpc-api和rpc-service模块，可按微服务拆分或场景拆分
+
+## 演示地址
+
+演示地址： [http://www.zhangshuzheng.cn/zhengAdmin/src/](http://www.zhangshuzheng.cn/zhengAdmin/src/ "演示地址")
+
+### 预览图
 ![预览效果图](https://github.com/shuzheng/zhengAdmin/raw/master/src/images/zheng-upms-crud.png)
 
-# 数据模型
-![数据库模型](project-datamodel/zheng.png)
+### 数据模型
+![数据库模型](https://github.com/shuzheng/zheng/raw/master/project-datamodel/zheng.png)
+
+### 拓扑图
+![拓扑图](https://github.com/shuzheng/zheng/raw/master/project-bootstrap/distributedSystem.png)
+
+## 许可证
 
-# 拓扑图
-![拓扑图](project-bootstrap/distributedSystem.png)
+[MIT](http://opensource.org/licenses/MIT "MIT")