📄 更新readme
This commit is contained in:
smallchill
parent
fd73d1bf00
commit
d37a240042
157
README.md
157
README.md
|
|
@ -1,70 +1,92 @@
|
|||
## 简介
|
||||
* Sword 是 [SpringBlade](https://gitee.com/smallc/SpringBlade)前端UI项目，基于react 、ant design、dva，用于快速构建系统中后台业务。
|
||||
* Sword 已入选 ant design 官方脚手架市场，地址：[scaffolds.ant.design](http://scaffold.ant.design/#/scaffolds/Sword)
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/license-Apache%202-blue.svg" alt="Build Status">
|
||||
<img src="https://img.shields.io/badge/Spring%20Cloud-Greenwich.SR1-blue.svg" alt="Coverage Status">
|
||||
<img src="https://img.shields.io/badge/Spring%20Boot-2.1.5.RELEASE-blue.svg" alt="Downloads">
|
||||
</p>
|
||||
|
||||
## 文档
|
||||
* 文档地址：[Sword开发手册](https://www.kancloud.cn/smallchill/sword)
|
||||
## SpringBlade微服务开发平台
|
||||
* 采用前后端分离的模式，前端开源两个框架：[Sword](https://gitee.com/smallc/Sword) (基于 React、Ant Design)、[Saber](https://gitee.com/smallc/Saber) (基于 Vue、Element-UI)
|
||||
* 后端采用SpringCloud全家桶，并同时对其基础组件做了高度的封装，单独开源出一个框架：[BladeTool](https://github.com/chillzhuang/blade-tool)
|
||||
* [BladeTool](https://github.com/chillzhuang/blade-tool)已推送至Maven中央库，直接引入即可，减少了工程的臃肿，也可更注重于业务开发
|
||||
* 集成Sentinel从流量控制、熔断降级、系统负载等多个维度保护服务的稳定性。
|
||||
* 注册中心、配置中心选型Nacos，为工程瘦身的同时加强各模块之间的联动。
|
||||
* 使用Traefik进行反向代理，监听后台变化自动化应用新的配置文件。
|
||||
* 极简封装了多租户底层，用更少的代码换来拓展性更强的SaaS多租户系统。
|
||||
* 借鉴OAuth2，实现了多终端认证系统，可控制子系统的token权限互相隔离。
|
||||
* 借鉴Security，封装了Secure模块，采用JWT做Token认证，可拓展集成Redis等细颗粒度控制方案。
|
||||
* 稳定生产了一年，经历了从Camden -> Greenwich的技术架构，也经历了从fat jar -> docker -> k8s + jenkins的部署架构
|
||||
* 项目分包明确，规范微服务的开发模式，使包与包之间的分工清晰。
|
||||
|
||||
## 架构图
|
||||
<img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/springblade-framework.png"/>
|
||||
|
||||
## 工程结构
|
||||
```
|
||||
SpringBlade
|
||||
├── blade-auth -- 授权服务提供
|
||||
├── blade-common -- 常用工具封装包
|
||||
├── blade-gateway -- Spring Cloud 网关
|
||||
├── blade-ops -- 运维中心
|
||||
├ ├── blade-admin -- spring-cloud后台管理
|
||||
├ ├── blade-develop -- 代码生成
|
||||
├── blade-service -- 业务模块
|
||||
├ ├── blade-desk -- 工作台模块
|
||||
├ ├── blade-log -- 日志模块
|
||||
├ ├── blade-system -- 系统模块
|
||||
├ └── blade-user -- 用户模块
|
||||
├── blade-service-api -- 业务模块api封装
|
||||
├ ├── blade-desk-api -- 工作台api
|
||||
├ ├── blade-dict-api -- 字典api
|
||||
├ ├── blade-system-api -- 系统api
|
||||
└── └── blade-user-api -- 用户api
|
||||
```
|
||||
|
||||
## 官网
|
||||
* 官网地址：[https://bladex.vip](https://bladex.vip)
|
||||
* 问答社区：[https://sns.bladex.vip](https://sns.bladex.vip)
|
||||
* 会员计划：[SpringBlade会员计划](https://gitee.com/smallc/SpringBlade/wikis/SpringBlade会员计划)
|
||||
* 交流群：`477853168`
|
||||
|
||||
## 在线演示
|
||||
* Sword演示地址：[https://sword.bladex.vip](https://sword.bladex.vip)
|
||||
* Saber演示地址：[https://saber.bladex.vip](https://saber.bladex.vip)
|
||||
|
||||
## 后端项目地址
|
||||
* [Gitee地址](https://gitee.com/smallc/SpringBlade)
|
||||
* [Github地址](https://github.com/chillzhuang/SpringBlade)
|
||||
|
||||
## 前端项目地址
|
||||
* [Sword--基于React](https://gitee.com/smallc/Sword)
|
||||
* [Saber--基于Vue](https://gitee.com/smallc/Saber)
|
||||
|
||||
## 特性
|
||||
|
||||
- :gem: **优雅美观**：基于 Ant Design 体系精心设计
|
||||
- :triangular_ruler: **常见设计模式**：提炼自中后台应用的典型页面和场景
|
||||
- :rocket: **最新技术栈**：使用 React/umi/dva/antd 等前端前沿技术开发
|
||||
- :iphone: **响应式**：针对不同屏幕大小设计
|
||||
- :art: **主题**：可配置的主题满足多样化的品牌诉求
|
||||
- :globe_with_meridians: **国际化**：内建业界通用的国际化方案
|
||||
- :zap: **最佳实践**：良好的工程实践助您持续产出高质量代码
|
||||
- :1234: **Mock 数据**：实用的本地数据调试方案
|
||||
- :white_check_mark: **UI 测试**：自动化测试保障前端产品质量
|
||||
|
||||
## 支持环境
|
||||
|
||||
现代浏览器及 IE11。
|
||||
|
||||
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
|
||||
| --------- | --------- | --------- | --------- | --------- |
|
||||
| IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions
|
||||
## 项目地址
|
||||
* 后端Gitee地址：[https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade)
|
||||
* 后端Github地址：[https://github.com/chillzhuang/SpringBlade](https://github.com/chillzhuang/SpringBlade)
|
||||
* 后端SpringBoot版：[https://gitee.com/smallc/SpringBlade/tree/2.0-boot/](https://gitee.com/smallc/SpringBlade/tree/2.0-boot/)
|
||||
* 前端框架Sword(基于React)：[https://gitee.com/smallc/Sword](https://gitee.com/smallc/Sword)
|
||||
* 前端框架Saber(基于Vue)：[https://gitee.com/smallc/Saber](https://gitee.com/smallc/Saber)
|
||||
* 核心框架项目地址：[https://github.com/chillzhuang/blade-tool](https://github.com/chillzhuang/blade-tool)
|
||||
|
||||
## 技术文档
|
||||
* [SpringBlade开发手册](https://gitee.com/smallc/SpringBlade/wikis/SpringBlade开发手册)
|
||||
|
||||
## 用户权益
|
||||
* 允许免费用于学习、毕设、公司项目、私活等。
|
||||
* 代码文件需保留相关license信息。
|
||||
|
||||
## 禁止事项
|
||||
* 直接将本项目挂淘宝等商业平台出售。
|
||||
* 业务代码50%以上相似度的二次开源，二次开源需先联系作者。
|
||||
|
||||
注意：若禁止条款被发现有权追讨19999的授权费。
|
||||
|
||||
## 如何启动
|
||||
```
|
||||
$ git clone https://gitee.com/smallc/Sword.git
|
||||
$ cd Sword
|
||||
$ npm install
|
||||
# mock模式
|
||||
$ npm start
|
||||
# 服务模式
|
||||
$ npm run start:no-mock
|
||||
# 访问 http://localhost:88
|
||||
```
|
||||
* 禁止直接将本项目挂淘宝等商业平台出售。
|
||||
* 非界面代码50%以上相似度的二次开源，二次开源需先联系作者。
|
||||
|
||||
# 界面
|
||||
## Sword界面一览
|
||||
|
||||
## [BladeX](https://bladex.vip/#/vip) 工作流一览
|
||||
<table>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/bladex-flow1.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/bladex-flow2.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/bladex-flow3.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/bladex-flow4.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/bladex-flow5.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/bladex-flow6.png"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## [Sword](https://gitee.com/smallc/Sword) 界面一览
|
||||
<table>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/sword-main.png"/></td>
|
||||
|
|
@ -88,6 +110,22 @@ $ npm run start:no-mock
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
## [Saber](https://gitee.com/smallc/Saber) 界面一览
|
||||
<table>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-user.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-role.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-dict.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-dict-select.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-log.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-code.png"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## 监控界面一览
|
||||
<table>
|
||||
<tr>
|
||||
|
|
@ -116,18 +154,5 @@ $ npm run start:no-mock
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
## Saber界面一览
|
||||
<table>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-user.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-role.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-dict.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-dict-select.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-log.png"/></td>
|
||||
<td><img src="https://gitee.com/smallc/SpringBlade/raw/master/pic/saber-code.png"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
## 关注我们
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user