项目说明

README.md

@@ -1,7 +1,30 @@
 # soraka
 
-#### 项目介绍
-一个基于Spring Cloud的基础开发框架
+- 前后端完全分离，基于Spring Boot 1.5.15.RELEASE
+- 基于网关的统一权限管理，更高效更方便
+- 基于`Spring Security OAuth`实现按钮级细粒度权限控制
+- Apache LICENSE 2.0，完全开源
+
+# 项目介绍
+Soraka一个基于Spring Cloud的基础通用开发框架，有高效率，低封装的特点，非常适合学习和中小企业直接作为开发框架使用。
+
+项目使用Maven进行管理，结构如下：
+
+``` lua
+soraka
+├── soraka-admin -- 管理模块（端口：8003）
+├── soraka-auth -- 权限模块（端口：8005）
+├── soraka-common -- 共用模块
+├── soraka-discovery -- 服务中心（端口：8001）
+├── soraka-gateway -- ZUUL网关（端口：80）
+├── soraka-weixin -- 微信模块（待实现 端口：8004）
+```
+前端项目链接：https://gitee.com/beiyoufx/soraka-view
+
+- 用户管理：完整的用户管理授权体系
+- 部门管理：配置系统组织机构，树结构展现，可随意调整上下级
+- 菜单管理：配置系统菜单，操作权限，按钮权限标识，图标等
+- 角色管理：角色菜单权限分配，最新的基于资源的权限控制（new RBAC）
 
 #### 软件架构
 软件架构说明
@@ -12,32 +35,13 @@
 5. 网关：Zuul
 6. 数据库：MySQL 5.7.16
 7. 微服务文档：Swagger2 2.7.0
+8. 安全框架：Spring Security OAuth
 
 #### 安装教程
 
-1. xxxx
-2. xxxx
-3. xxxx
-
-#### 使用说明
-
-1. xxxx
-2. xxxx
-3. xxxx
-
-#### 参与贡献
-
-1. Fork 本项目
-2. 新建 Feat_xxx 分支
-3. 提交代码
-4. 新建 Pull Request
-
-
-#### 码云特技
-
-1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
-2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
-3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
-4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
-5. 码云官方提供的使用手册 [http://git.mydoc.io/](http://git.mydoc.io/)
-6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
+1. 需要Java环境，JDK1.8以上
+2. 需要MySQL数据库，数据库字符集utf-8mb4
+3. 执行脚本`soraka\soraka-admin\soraka-init.sql`初始化数据库
+4. 修改`soraka-admin`数据库地址
+5. 依次启动`soraka-discovery`、`soraka-admin`、`soraka-auth`、`soraka-gateway`
+6. 前端项目在：https://gitee.com/beiyoufx/soraka-view