diff --git a/README.md b/README.md index 4abf20cc0d..25f1d1dff5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,213 @@ -# dataease -DataEase +# DataEase 开源数据可视化分析平台 + +DataEase 是开源的数据可视化分析工具，帮助用户分析数据、改善业务。DataEase 支持丰富的数据源连接，能够通过拖拉拽方式快速制作图表，并可以方便的与他人分享。 + +- 图表展示: 支持 PC 端、移动端及大屏; +- 图表制作: 支持丰富的图表类型(基于 Apache ECharts 实现)、支持拖拉拽方式快速制作仪表板; +- 数据引擎: 支持直连模式、本地模式(基于 Apache Doris / Kettle 实现); +- 数据连接: 支持关系型数据库、Excel 等文件、Hadoop 等大数据平台、NoSQL 等各种数据源。 + +## 功能架构 + +TBD + +## UI 展示 + +TBD + +## 快速开始 + +仅需两步快速安装 DataEase： + +1. 准备一台不小于 16 G内存的 64位 Linux 主机； +2. 以 root 用户执行如下命令一键安装 DataEase。 + +```sh +curl -sSL https://github.com/dataease/dataease/releases/latest/download/quick_start.sh | sh +``` + +文档和演示视频： + +- [完整文档](https://dataease.io/docs/) +- [演示视频] TBD + +## 版本说明 + +DataEase 版本号命名规则为：v大版本.功能版本.Bug修复版本。比如： + +```text +v1.0.1 是 v1.0.0 之后的 Bug 修复版本； +v1.1.0 是 v1.0.0 之后的功能版本。 +``` + +像其它优秀开源项目一样，DataEase 将每月发布一个功能版本。 + +## 产品优势 + +- 开源开放：零门槛，线上快速获取和安装；快速获取用户反馈、按月发布新版本； +- 简单易用：极易上手，通过鼠标点击和拖拽即可完成分析； +- 秒级响应：集成 Apache Doris，超大数据量下秒级查询返回延时； +- 安全分享：支持多种数据分享方式，确保数据安全。 + +## 功能列表 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
仪表板仪表板管理在线编辑仪表板
仪表板展示内容支持视图/时间组件/文本组件/数字组件/样式组件等
支持视图及组件样式的设置
支持仪表板主题
支持仪表板的全屏预览
支持仪表板模板的导出
以树状形式展示仪表板分组
支持仪表板分组的拖拽排序
支持默认仪表板的设置
支持仪表板的收藏
仪表板分享支持按组织/角色/用户分享
支持生成外部可访问的带密码保护的分享链接
视图视图管理在线编辑视图
支持可视化拖拽进行视图操作
支持明细表/指标卡/基础柱状图/堆叠柱状图/横向柱状图/横向堆叠柱状图/基础折线图/堆叠折线图/饼图/南丁格尔玫瑰图/漏斗图/雷达图/仪表盘等多种图表类型
支持维度/指标的排序展示
支持指标的多种汇总计算方式
支持对图表类型的图形属性进行设置
支持对图表类型的组件样式进行设置
支持过滤条件筛选视图展示的数据
支持下载视图图片
数据集数据集管理支持数据库数据集/SQL 数据集/Excel 数据集/自定义数据集等多种类型的数据集
数据库数据集和 SQL 数据集支持直连和定时同步两种连接方式
定时同步类型数据集支持全量更新和增量更新两种方式
支持定时更新的频率控制
支持定时更新任务的查看
支持对数据集的字段类型/字段名/展示字段进行设置
支持创建不同类型数据集与数据集之间的关联
支持 Excel 数据集数据的替换和更新
数据源数据源管理支持 MySQL 和 SQL Server 类型的数据源
支持对数据源有效性校验
系统管理用户租户管理支持多级租户体系
支持多种租户角色
权限管理支持组织/角色/用户三个维度的权限管理
支持数据源/数据集/视图/仪表板/菜单和操作权限的细颗粒度权限控制
显示设置支持对Logo/系统名/标题等属性的设置
+ + + +## 技术栈 + +- 后端: [Spring Boot](https://www.tutorialspoint.com/spring_boot/spring_boot_introduction.htm) +- 前端: [Vue.js](https://vuejs.org/) +- 中间件: [MySQL](https://www.mysql.com/) +- 数据处理: [Kettle](https://community.hitachivantara.com/s/article/data-integration-kettle/), [Apache Doris](https://doris.apache.org/) +- 基础设施: [Docker](https://www.docker.com/) + +## 致谢 + +- [Kettle](https://community.hitachivantara.com/s/article/data-integration-kettle/)：DataEase 使用了 Kettle 进行数据处理工作 +- [Apache Doris](https://doris.apache.org/)：DataEase 使用了 Apache Doris 进行快速的数据分析 +- [Element](https://element.eleme.cn/#/)：感谢 Element 提供的优秀组件库 + +## 微信群 + +![wechat-group](https://dataease.oss-cn-hangzhou.aliyuncs.com/img/wechat-group.png) + + +## License & Copyright + +Copyright (c) 2014-2021 飞致云 FIT2CLOUD, All rights reserved. + +Licensed under The GNU General Public License version 2 (GPLv2) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at + + + +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. + +