Przeglądaj źródła

refactor: 修改readme

liu.chengbiao 1 rok temu
rodzic
commit
28aaa0aed8
7 zmienionych plików z 3 dodań i 328 usunięć
  1. 0 5
      .gitignore
  2. 0 0
      DataRoom/.gitkeep
  3. 0 38
      DataRoom/CONTRIBUTING.md
  4. 0 201
      DataRoom/LICENSE
  5. 0 57
      DataRoom/README.md
  6. 0 20
      DataRoom/SECURITY.md
  7. 3 7
      README.md

+ 0 - 5
.gitignore

@@ -1,11 +1,6 @@
-gc-starter-dashboard-ui.zip
-gc-starter-dashboard-ui
-chuangDa
-chuangDa.zip
 deploy.sh
 bigScreen
 dist
-gc-starter-lowcode-ui
 ### VisualStudioCode template
 .vscode/*
 !.vscode/settings.json

+ 0 - 0
DataRoom/.gitkeep


+ 0 - 38
DataRoom/CONTRIBUTING.md

@@ -1,38 +0,0 @@
-## 如何贡献
-
-感谢您对我们的项目感兴趣,并愿意为其做出贡献!以下是一些指南,帮助您开始:
-
-### 提交问题
-
-如果您在使用本项目时遇到了任何问题,请先查看现有的 Issue 列表以确认是否已经有人提出该问题。如果没有,请按照以下步骤提交新问题:
-
-1. 点击 Issues 标签页。
-2. 单击 New issue 按钮。
-3. 输入问题的标题和详细描述。
-4. 单击 Submit new issue 按钮。
-
-### 提交 Pull Request
-
-如果您希望修改代码或者添加新功能,可以通过提交 Pull Request 的方式进行。请按照以下步骤进行:
-
-1. Fork 本项目。
-2. 创建一个新分支,提交您的修改。
-3. 在您的 forked repository 页面上点击 New pull request 按钮。
-4. 输入您的 Pull Request 描述信息,并提交请求。
-
-### 代码规范
-
-我们非常注重代码风格和规范。为了保持代码的一致性和易读性,请遵循以下规则:
-
-- 使用 4 个空格缩进。
-- 行宽度不超过 80 个字符。
-- 函数和变量名使用下划线连接。
-
-### 社区行为准则
-
-我们希望社区成员能够遵守以下行为准则:
-
-- 尊重他人,不进行攻击、嘲讽等行为。
-- 积极参与社区活动,分享知识和经验。
-- 禁止发布任何形式的广告、垃圾邮件等信息。
-- 尊重知识产权,不侵犯他人的版权或专利等权益。

+ 0 - 201
DataRoom/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

+ 0 - 57
DataRoom/README.md

@@ -1,60 +1,3 @@
-## 📚简介
-<p align="center">
-	<img alt="logo" width="50" src="./doc/logo.png">
-</p>
-
-🔥基于SpringBoot、MyBatisPlus、ElementUI、G2Plot、Echarts等技术栈的大屏设计器,具备大屏目录管理、大屏设计、大屏预览能力,支持MySQL、Oracle、PostgreSQL、JSON等数据集接入,对于复杂数据处理还可以使用Groovy脚本数据集,使用简单,完全免费,代码开源。
-
-<p align="center">
-    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/gcpaas/gc-starter-bigscreen?style=social">
-	<img alt="GitHub forks" src="https://img.shields.io/github/forks/gcpaas/gc-starter-bigscreen?style=social">
-	<img alt="GitHub license" src="https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg">
-    <img alt="Maven Central" src="https://img.shields.io/maven-central/v/com.gccloud/dataroom-core">
-	<img alt="Company" src="https://img.shields.io/badge/Author-科大国创云网科技有限公司-blue.svg">
-  	<img alt="QQ" src="https://img.shields.io/badge/QQ-322302395-blue.svg">
-</p>
-
--------------------------------------------------------------------------------
-## 效果图
-
-#### 管理页
-<img alt="logo" src="./doc/images/home.png">
-
-#### 设计器
-<img alt="logo" src="./doc/images/design01.png">
-
-## 优势
-
-* 一站式大屏解决方案,从**数据处理**->**大屏设计**->**大屏预览**->**生产使用**
-* 支持**多种数据集接入**,可用于生产
-* 支持🔥**独立部署**,不对原有工程产生影响,适用于老项目
-* 支持🔥**嵌入式集成**,与项目无缝融合,引入依赖包即可,无其他系统框架依赖,减少运维成本,适用于新项目
-* 支持🔥**组件在线、离线开发**,在线开发简单组件、离线开发复杂组件
-* 支持自定义接口权限、数据权限,轻松对接🔥**Shiro、Security**等认证框架,保证大屏数据安全
-
-## 功能
-- [x] 支持大屏管理、设计、预览、导出、集成
-- [x] 支持图层上下调整,支持置于顶层、置于底层
-- [x] 支持图画布组件框选、组合、取消组合、锁定、批量删除、复制功能
-- [x] 支持文本、图片、轮播表、排名表、翻牌器、基础表格、倒计时、系统时间、外链
-- [x] 支持基础折线图、梯形图、柱状图、面积图、条形图、饼图、环图、水波图、仪表盘、进度条、词云图、雷达图、漏斗图等
-- [x] 支持15种边框组件,支持动画、渐变色设置,支持水平线、垂直线设置
-- [x] 支持10多种修饰组件,支持动画、渐变色设置
-- [x] 支持资源管理,包含LOGO、3D图标、2D图表、修饰、背景等上百个大屏设计资源,资源支持自定义上传
-- [x] 支持组件管理,支持组件化设计,包含系统组件、自定义组件、业务组件,一键复用组件
-- [x] 支持数据源管理,支持MySQL、ClickHouse、PostgreSQL、Oracle
-- [x] 支持数据集管理,支持原始数据集、自助数据集、存储过程数据集、JSON数据集、脚本数据集、HTTP数据集,接入不同来源数据
-- [x] 支持自定义接口权限、数据权限,保证大屏数据安全
-- [x] 支持组件自定义规范,按照规范开发自己的大屏组件,满足特殊需求,如:自定义网络拓扑
-
-## 链接
-
-* [使用手册、二次开发、部署手册、常见问题](https://www.yuque.com/chuinixiongkou/bigscreen/index)
-* [前端代码仓库(GitHub)](https://github.com/gcpaas/gc-starter-bigscreen-ui)、[前端代码仓库(码云)](https://gitee.com/gcpaas/gc-starter-bigscreen-ui)
-* [后端代码仓库(GitHub)](https://github.com/gcpaas/gc-starter-bigscreen)、 [后端代码仓库(码云)](https://gitee.com/gcpaas/gc-starter-bigscreen)
-
--------------------------------------------------------------------------------
-
 ## 如何集成
 
 下面介绍如何在SpringBoot项目中集成大屏,[📘前端大屏地址在这里](https://github.com/gcpaas/gc-starter-bigscreen-ui)

+ 0 - 20
DataRoom/SECURITY.md

@@ -1,20 +0,0 @@
-# 安全策略
-
-本文档描述了我们团队如何处理安全问题和漏洞。如果您发现了潜在的安全问题,请发送电子邮件至 tech@ustcinfo.com。
-
-## 报告漏洞
-
-如果您发现了漏洞,请按照以下步骤报告:
-
-1. 发送电子邮件至 tech@ustcinfo.com,并提供有关漏洞的详细信息。
-2. 我们将尽快回复,确认收到您的漏洞报告。
-3. 我们会评估漏洞的严重性,并决定是否需要紧急修复。
-4. 一旦修复程序可用,我们将联系您并要求您验证它们是否已解决漏洞。 
-
-## 安全问题处理时间
-
-我们承诺在漏洞报告收到后的24小时内回应,并在60天内解决所有已确认的漏洞。如果无法在该时间内解决,则我们将向您提供更新,并解释原因。
-
-## 安全策略更新
-
-我们保留随时更改此安全策略的权利,因此请经常查看以获取最新信息。如果您对我们的安全策略有任何疑问,请随时与我们联系。

+ 3 - 7
README.md

@@ -50,21 +50,17 @@
 
 ## 快速开始
 
-[👉前端开发者](./data-room-ui/README.md)
-
-[👉后端开发者](./DataRoom/README.md)
+[开始开始](https://www.yuque.com/chuinixiongkou/bigscreen/ofy1bqhqgua1fu0f)
 
 ## 演示DEMO
 
 <a href="http://gcpaas.gccloud.com/bigScreen" target="_blank"> http://gcpaas.gccloud.com/bigScreen </a>
-<span style="color: red">(请不要在演示环境中放入生产数据)</span>
+<span style="color: red;font-weight: bold;">(请不要在演示环境中放入生产数据)</span>
 
 ## 常见问题
 
 * [使用手册、二次开发、部署手册、常见问题](https://www.yuque.com/chuinixiongkou/bigscreen/index)
-* [前端代码仓库(GitHub)](https://github.com/gcpaas/DataRoom/tree/master/data-room-ui)、[前端代码仓库(码云)](https://gitee.com/gcpaas/gc-starter-bigscreen-ui)
-* [后端代码仓库(GitHub)](https://github.com/gcpaas/DataRoom/tree/master/DataRoom)、 [后端代码仓库(码云)](https://gitee.com/gcpaas/gc-starter-bigscreen)
-
+* [代码仓库(GitHub)](https://github.com/gcpaas/DataRoom)、[代码仓库(码云)](https://gitee.com/gcpaas/DataRoom)
 
 ## 联系我们