From f1915ff0485b0afe1cabace120843f47327e8ea6 Mon Sep 17 00:00:00 2001 From: smallwei <1634566606@qq.com> Date: Sat, 25 Mar 2023 11:30:25 +0800 Subject: [PATCH] update:rm docs --- README.md | 216 +++++++++++------------------------------------------- 1 file changed, 43 insertions(+), 173 deletions(-) diff --git a/README.md b/README.md index 87f0def..0de6efe 100644 --- a/README.md +++ b/README.md @@ -1,173 +1,43 @@ -

- Downloads - Build Status - Build Status - Coverage Status - Downloads - - Downloads - - - Downloads - -

- -## SpringBlade微服务开发平台 -* 采用前后端分离的模式,前端开源两个框架:[Sword](https://gitee.com/smallc/Sword) (基于 React、Ant Design)、[Saber](https://gitee.com/smallc/Saber) (基于 Vue、Element-UI) -* 后端采用SpringCloud全家桶,并同时对其基础组件做了高度的封装,单独开源出一个框架:[BladeTool](https://gitee.com/smallc/blade-tool) -* [BladeTool](https://github.com/chillzhuang/blade-tool)已推送至Maven中央库,直接引入即可,减少了工程的臃肿,也可更注重于业务开发 -* 集成Sentinel从流量控制、熔断降级、系统负载等多个维度保护服务的稳定性。 -* 注册中心、配置中心选型Nacos,为工程瘦身的同时加强各模块之间的联动。 -* 使用Traefik进行反向代理,监听后台变化自动化应用新的配置文件。 -* 极简封装了多租户底层,用更少的代码换来拓展性更强的SaaS多租户系统。 -* 借鉴OAuth2,实现了多终端认证系统,可控制子系统的token权限互相隔离。 -* 借鉴Security,封装了Secure模块,采用JWT做Token认证,可拓展集成Redis等细颗粒度控制方案。 -* 稳定生产了三年,经历了从 Camden -> Hoxton -> 2021 的技术架构,也经历了从fat jar -> docker -> k8s + jenkins的部署架构。 -* 项目分包明确,规范微服务的开发模式,使包与包之间的分工清晰。 - -## 架构图 - - -## 官方信息 -* 官网地址:[https://bladex.vip](https://bladex.vip) -* 问答社区:[https://sns.bladex.vip](https://sns.bladex.vip) -* 会员计划:[SpringBlade会员计划](https://gitee.com/smallc/SpringBlade/wikis/SpringBlade会员计划) -* 交流一群:`477853168`(满) -* 交流二群:`751253339`(满) -* 交流三群:`784729540`(满) -* 交流四群:`1034621754`(满) -* 交流五群:`946350912`(满) -* 交流六群:`511624269`(满) -* 交流七群:`298061704` - -## 在线演示 -* Saber-基于Vue:[https://saber.bladex.vip](https://saber.bladex.vip) -* Sword-基于React:[https://sword.bladex.vip](https://sword.bladex.vip) - -## 数据大屏 -* Caster-数据大屏展示系统:[https://caster.bladex.vip](https://caster.bladex.vip) - -## 技术文档 -* [SpringBlade开发手册一览](https://gitee.com/smallc/SpringBlade/wikis/SpringBlade开发手册) -* [SpringBlade常见问题集锦](https://sns.bladex.vip/article-14966.html) -* [SpringBlade基于Kuboard部署K8S](https://kuboard.cn/learning/k8s-practice/spring-blade/) -* [SpringBlade基于Rainbond部署](https://www.rainbond.com/docs/micro-service/example/blade) - -## 项目地址 -* 核心框架项目地址:[https://gitee.com/smallc/blade-tool](https://gitee.com/smallc/blade-tool) -* 后端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/boot/](https://gitee.com/smallc/SpringBlade/tree/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) - -# 开源协议 -Apache Licence 2.0 ([英文原文](http://www.apache.org/licenses/LICENSE-2.0.html)) -Apache Licence是著名的非盈利开源组织Apache采用的协议。该协议和BSD类似,同样鼓励代码共享和尊重原作者的著作权,同样允许代码修改,再发布(作为开源或商业软件)。 -需要满足的条件如下: -* 需要给代码的用户一份Apache Licence -* 如果你修改了代码,需要在被修改的文件中说明。 -* 在延伸的代码中(修改和有源代码衍生的代码中)需要带有原来代码中的协议,商标,专利声明和其他原来作者规定需要包含的说明。 -* 如果再发布的产品中包含一个Notice文件,则在Notice文件中需要带有Apache Licence。你可以在Notice中增加自己的许可,但不可以表现为对Apache Licence构成更改。 - Apache Licence也是对商业应用友好的许可。使用者也可以在需要的时候修改代码来满足需要并作为开源或商业产品发布/销售。 - -## 用户权益 -* 允许免费用于学习、毕设、公司项目、私活等,但请保留源码作者信息。 -* 对未经过授权和不遵循 Apache 2.0 协议二次开源或者商业化我们将追究到底。 -* 参考请注明:参考自 SpringBlade:https://gitee.com/smallc/SpringBlade。 - -## 如何启动 -``` -$ git clone https://gitee.com/smallc/Saber.git -$ cd Saber -# 安装 -$ yarn install -# 启动 -$ yarn run serve -``` - -# 界面 - -## [BladeX](https://bladex.vip/#/vip) 工作流一览 - - - - - - - - - - - - - -
- -## [Sword](https://gitee.com/smallc/Sword) 界面一览 - - - - - - - - - - - - - - - - - - - - - -
- -## [Saber](https://gitee.com/smallc/Saber) 界面一览 - - - - - - - - - - - - - -
- -## 监控界面一览 - - - - - - - - - - - - - - - - - - - - - - - - - -
\ No newline at end of file +## 版权声明 +* BladeX是一个商业化软件,系列产品知识产权归**上海布雷德科技有限公司**独立所有 +* 您一旦开始复制、下载、安装或者使用本产品,即被视为完全理解并接受本协议的各项条款 +* 更多详情请看:[BladeX商业授权许可协议](/LICENSE) + +## 答疑流程 +>1. 遇到问题或Bug +>2. 业务型问题打断点调试尝试找出问题所在 +>3. 系统型问题通过百度、谷歌、社区查找解决方案 +>4. 未解决问题则进入技术社区进行发帖提问:[https://sns.bladex.vip/](https://sns.bladex.vip/) +>5. 将帖子地址发至商业群,特别简单三言两语就能描述清楚的也可在答疑时间内发至商业群提问 +>6. 发帖的时候一定要描述清楚,详细描述遇到问题的**重现步骤**、**报错详细信息**、**相关代码与逻辑**、**使用软件版本**以及**操作系统版本**,否则随意发帖提问将会提高我们的答疑难度。 + +## 答疑时间 +* 工作日:9:00 ~ 17:00 提供答疑,周末、节假日休息,暂停答疑 +* 请勿**私聊提问**,以免被其他用户的消息覆盖从而无法获得答疑 +* 答疑时间外遇到问题可以将问题发帖至[技术社区](https://sns.bladex.vip/),我们后续会逐个回复 + +## 授权范围 +* 专业版:只可用于**个人学习**及**个人私活**项目,不可用于公司或团队,不可泄露给任何第三方 +* 企业版:可用于**企业名下**的任何项目,企业版员工在**未购买**专业版授权前,只授权开发**所在授权企业名下**的项目,**不得将BladeX用于个人私活** +* 共同遵守:若甲方需要您提供项目源码,则需代为甲方购买BladeX企业授权,甲方购买后续的所有项目都无需再次购买授权 + +## 商用权益 +* ✔️ 遵守[商业协议](/LICENSE)的前提下,将BladeX系列产品用于授权范围内的商用项目,并上线运营 +* ✔️ 遵守[商业协议](/LICENSE)的前提下,不限制项目数,不限制服务器数 +* ✔️ 遵守[商业协议](/LICENSE)的前提下,将自行编写的业务代码申请软件著作权 + +## 何为侵权 +* ❌ 不遵守商业协议,私自销售商业源码 +* ❌ 以任何理由将BladeX源码用于申请软件著作权 +* ❌ 将商业源码以任何途径任何理由泄露给未授权的单位或个人 +* ❌ 开发完毕项目,没有为甲方购买企业授权,向甲方提供了BladeX代码 +* ❌ 基于BladeX拓展研发与BladeX有竞争关系的衍生框架,并将其开源或销售 + +## 侵权后果 +* 情节较轻:第一次发现警告处理 +* 情节较重:封禁账号,踢出商业群,并保留追究法律责任的权利 +* 情节严重:与本地律师事务所合作,以公司名义起诉侵犯计算机软件著作权 + +## 举报有奖 +* 向官方提供有用线索并成功捣毁盗版个人或窝点,将会看成果给予 500~10000 不等的现金奖励 +* 官方唯一指定QQ:1272154962 \ No newline at end of file