diff --git a/README.md b/README.md index 0efff838..a9cb3345 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,129 @@ -## 📚简介 - -🔥DataRoom是一款基于SpringBoot、MyBatisPlus、ElementUI、G2Plot、Echarts等技术栈的大屏设计器,具备大屏目录管理、大屏设计、大屏预览能力,支持MySQL、Oracle、PostgreSQL、JSON、HTTP、Groovy等数据集接入,使用简单,完全免费,代码开源。 +
+

DataRoom

+ 简单、免费的开源大屏设计器 +

stars forks GitHub license npm - Maven Central + Maven Central Company

-------------------------------------------------------------------------------- +🔥DataRoom是一款基于SpringBoot、MyBatisPlus、ElementUI、G2Plot、Echarts等技术栈的大屏设计器,具备大屏设计、预览能力,支持MySQL、Oracle、PostgreSQL、JSON、JS、HTTP、Groovy等数据集接入,使用简单,完全免费,代码开源。 ## 效果图 -#### 管理页 +### 1. 大屏管理 + +进行大屏【新增】、【编辑】、【设计】、【预览】、【复制】、【删除】操作 + +
+ + + +### 2. 设计器 + +采用拖拉拽可视化设计,支持20+种图表组件、15种边框组件、10多种修饰组件 + + + +### 3. 资源库 + +支持资源自定义上传、在大屏设计器中直接引用资源,如:3D图片、边框图片、装饰条、背景图 + +logo + + + +### 4. 数据源 -logo +支持MySQL、PostgreSQL、Oracle 、ClickHouse数据库接入 -#### 设计器 +logo -logo +### 4. 数据集 + +支持原始数据集、自助数据集、存储过程数据集、JSON数据集、脚本数据集、JS脚本数据集、HTTP数据集多种方式接入数据 + +logo + +
## 优势 -* 一站式大屏解决方案,从**数据处理**->**大屏设计**->**大屏预览**->**生产使用** -* 支持**多种数据集接入**,可用于生产 -* 支持🔥**独立部署**,不对原有工程产生影响,适用于老项目 -* 支持🔥**嵌入式集成**,与项目无缝融合,引入依赖包即可,无其他系统框架依赖,减少运维成本,适用于新项目 -* 支持🔥**组件在线、离线开发**,在线开发简单组件、离线开发复杂组件 -* 支持自定义接口权限、数据权限,轻松对接🔥**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] 支持组件自定义规范,按照规范开发自己的大屏组件,满足特殊需求,如:自定义网络拓扑 +✅ 一站式大屏解决方案,从**数据接入**->**大屏设计**->**大屏预览**->**生产使用**
+✅ 支持**多种数据集接入**,满足大多数数据接入需求
+✅ 支持大屏🔥**独立部署**,不对原有工程产生影响,适用于老项目
+✅ 支持大屏🔥**嵌入式集成**,与项目无缝融合,引入依赖包即可,无其他系统框架依赖,减少运维成本,适用于新项目
+✅ 支持🔥**组件在线、离线开发**,在线开发简单组件、离线开发复杂组件
+✅ 支持自定义接口权限、数据权限,轻松对接🔥**Shiro、Security**等认证框架,保证大屏数据安全
+ +
+ +## 特性 + +| 特性 | 支持 | +| :----------------------------------------------------------- | ---- | +| 支持大屏、设计、预览、导出图片、项目集成 | ✅ | +| 支持图层上下调整,支持置于顶层、置于底层 | ✅ | +| 支持画布组件框选、组合、取消组合、锁定、批量删除、复制功能 | ✅ | +| 支持文本、图片、轮播表、排名表、翻牌器、基础表格、倒计时、系统时间、外链基础组件 | ✅ | +| 支持折线图、梯形图、柱状图、面积图、条形图、饼图、环图、水波图、仪表盘、进度条、词云图、雷达图、漏斗图等图表组件 | ✅ | +| 支持15种边框组件,具备动画、渐变色设置 | ✅ | +| 支持10多种修饰组件,具备动画、渐变色设置 | ✅ | +| 支持资源管理,包含LOGO、3D图标、2D图标、修饰条、背景图等上百个大屏设计资源,资源支持自定义上传 | ✅ | +| 支持组件管理,包含系统组件、自定义组件、业务组件,组件支持二次开发 | ✅ | +| 支持多种数据源,目前支持MySQL、PostgreSQL、Oracle、ClickHouse数据库 | ✅ | +| 支持多种数据集,目前支持原始数据集、自助数据集、存储过程数据集、JSON数据集、JS数据集、脚本数据集、HTTP数据集,接入不同来源数据 | ✅ | +| 支持自定义权限、具备自定义接口权限、数据权限,保证大屏数据安全 | ✅ | +| 支持组件自定义规范,按照规范开发自己的大屏组件,满足特殊需求,如:接入three.js | ✅ | + +
## 快速开始 -[开始开始](https://www.yuque.com/chuinixiongkou/bigscreen/ofy1bqhqgua1fu0f) +> 如果你想源码启动,[👉 请点击这里](https://www.yuque.com/chuinixiongkou/bigscreen/ofy1bqhqgua1fu0f) + +> 如果你想将大屏集成到项目中,[👉 请点击这里](https://www.yuque.com/chuinixiongkou/bigscreen/ofy1bqhqgua1fu0f) + +> 如果你想设计一个大屏,[👉 请点击这里](https://www.yuque.com/chuinixiongkou/bigscreen/ofy1bqhqgua1fu0f) + +
+ +## 演示环境 -## 演示DEMO +演示环境会不定期进行更新,请不要在演示环境中放入生产数据 立即在线使用 - http://gcpaas.gccloud.com/bigScreen -(请不要在演示环境中放入生产数据) +
## 常见问题 * [使用手册、二次开发、部署手册、常见问题](https://www.yuque.com/chuinixiongkou/bigscreen/index) * [代码仓库(GitHub)](https://github.com/gcpaas/DataRoom)、[代码仓库(码云)](https://gitee.com/gcpaas/DataRoom) +
+ +## 生态插件 + +| 组件 | 地址 | +| ------------ | ------------------------------------------------------------ | +| 大屏设计器 | [码云](https://gitee.com/gcpaas/DataRoom)、[GitHub](https://github.com/gcpaas/DataRoom) | +| 仪表盘设计器 | [码云](https://gitee.com/gcpaas/DashBoard)、[GitHub](https://github.com/gcpaas/DashBoard) | +| 数据集 | [码云](https://gitee.com/gcpaas/dataset)、[GitHub](https://github.com/gcpaas/dataset) | + +
+ + ## 联系我们

logo

-## License + +## 许可证 Apache License 2.0 \ No newline at end of file diff --git a/doc/images/home.png b/doc/images/大屏管理.png similarity index 100% rename from doc/images/home.png rename to doc/images/大屏管理.png diff --git a/doc/images/数据源.png b/doc/images/数据源.png new file mode 100644 index 00000000..21460a7e Binary files /dev/null and b/doc/images/数据源.png differ diff --git a/doc/images/数据集.png b/doc/images/数据集.png new file mode 100644 index 00000000..4bc65e6f Binary files /dev/null and b/doc/images/数据集.png differ diff --git a/doc/images/design01.png b/doc/images/设计器.png similarity index 100% rename from doc/images/design01.png rename to doc/images/设计器.png diff --git a/doc/images/资源库.png b/doc/images/资源库.png new file mode 100644 index 00000000..764fb849 Binary files /dev/null and b/doc/images/资源库.png differ