diff --git a/.github/ISSUE_TEMPLATE/bug---.md b/.github/ISSUE_TEMPLATE/bug---.md index 8e60e11da7..2670424e7f 100644 --- a/.github/ISSUE_TEMPLATE/bug---.md +++ b/.github/ISSUE_TEMPLATE/bug---.md @@ -3,13 +3,16 @@ name: Bug 提交 about: 提交产品缺陷帮助我们更好的改进 title: "[Bug]" labels: 类型:bug -assignees: tjlygdx +assignees: BBchicken-9527, youliyuan-fit2cloud, zyyfit --- **DataEase 版本** +**运行方式(安装包运行 or 源码运行 ?)** + + **浏览器版本** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..5e3e52506b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +#### What this PR does / why we need it? + +#### Summary of your change + +#### Please indicate you've done the following: + +- [ ] Made sure tests are passing and test coverage is added if needed. +- [ ] Made sure commit message follow the rule of [Conventional Commits specification](https://www.conventionalcommits.org/). +- [ ] Considered the docs impact and opened a new docs issue or PR with docs changes if needed. diff --git a/.github/workflows/issue-check-inactive.yml b/.github/workflows/issue-check-inactive.yml new file mode 100644 index 0000000000..6ca5f9f3e8 --- /dev/null +++ b/.github/workflows/issue-check-inactive.yml @@ -0,0 +1,16 @@ +name: Issue Check Inactive + +on: + schedule: + - cron: "0 0 */15 * *" + +jobs: + issue-check-inactive: + runs-on: ubuntu-latest + steps: + - name: check-inactive + uses: actions-cool/issues-helper@v2 + with: + actions: 'check-inactive' + inactive-label: 'Inactive' + inactive-day: 30 diff --git a/.github/workflows/issue-close-require.yml b/.github/workflows/issue-close-require.yml new file mode 100644 index 0000000000..431fbc75f8 --- /dev/null +++ b/.github/workflows/issue-close-require.yml @@ -0,0 +1,19 @@ +name: Issue Close Require + +on: + schedule: + - cron: "0 0 * * *" + +jobs: + issue-close-require: + runs-on: ubuntu-latest + steps: + - name: need reproduce + uses: actions-cool/issues-helper@v2 + with: + actions: 'close-issues' + labels: '状态:待反馈' + inactive-day: 30 + body: | + 您超过 30 天未反馈信息，我们将关闭该 issue，如有需求您可以重新打开或者提交新的 issue。 + diff --git a/.github/workflows/issue-comment.yml b/.github/workflows/issue-comment.yml new file mode 100644 index 0000000000..5388111d7c --- /dev/null +++ b/.github/workflows/issue-comment.yml @@ -0,0 +1,38 @@ +on: + issue_comment: + types: [created] + +name: Add issues workflow labels + +jobs: + add-label-if-is-author: + runs-on: ubuntu-latest + if: (github.event.issue.user.id == github.event.comment.user.id) && !github.event.issue.pull_request && (github.event.issue.state == 'open') + steps: + - name: Add require handle label + uses: actions-cool/issues-helper@v2 + with: + actions: 'add-labels' + labels: '状态:待处理' + + - name: Remove require reply label + uses: actions-cool/issues-helper@v2 + with: + actions: 'remove-labels' + labels: '状态:待反馈' + + add-label-if-not-author: + runs-on: ubuntu-latest + if: (github.event.issue.user.id != github.event.comment.user.id) && !github.event.issue.pull_request && (github.event.issue.state == 'open') + steps: + - name: Add require replay label + uses: actions-cool/issues-helper@v2 + with: + actions: 'add-labels' + labels: '状态:待反馈' + + - name: Remove require handle label + uses: actions-cool/issues-helper@v2 + with: + actions: 'remove-labels' + labels: '状态:待处理' diff --git a/.github/workflows/issue-inactive-alert.yml b/.github/workflows/issue-inactive-alert.yml new file mode 100644 index 0000000000..29e6fd41a3 --- /dev/null +++ b/.github/workflows/issue-inactive-alert.yml @@ -0,0 +1,17 @@ +on: + schedule: + - cron: "0 9 * * 1-5" + +name: Check untimely handle issues + +jobs: + check-untimely-handle-issues: + runs-on: ubuntu-latest + steps: + - name: Check untimely issues and send msg + uses: jumpserver/action-issues-alert@master + with: + hook: ${{ secrets.WECHAT_GROUP_WEB_HOOK }} + type: untimely + env: + GITHUB_TOKEN: ${{ secrets.GITHUBTOKEN }} diff --git a/.github/workflows/issue-open.yml b/.github/workflows/issue-open.yml new file mode 100644 index 0000000000..4d8bd425b7 --- /dev/null +++ b/.github/workflows/issue-open.yml @@ -0,0 +1,16 @@ +name: Issue Open Check + +on: + issues: + types: [opened] + +jobs: + issue-open-add-labels: + runs-on: ubuntu-latest + steps: + - name: Add labels + uses: actions-cool/issues-helper@v2 + if: ${{ !github.event.comment.pull_request.pull_request }} + with: + actions: 'add-labels' + labels: '状态:待处理' diff --git a/.github/workflows/issue-recent-alert.yml b/.github/workflows/issue-recent-alert.yml new file mode 100644 index 0000000000..f0dca89426 --- /dev/null +++ b/.github/workflows/issue-recent-alert.yml @@ -0,0 +1,17 @@ +on: + schedule: + - cron: "0 1 * * *" + +name: Check recent handle issues + +jobs: + check-recent-issues-not-handle: + runs-on: ubuntu-latest + steps: + - name: Check recent issues and send msg + uses: jumpserver/action-issues-alert@master + with: + hook: ${{ secrets.WECHAT_GROUP_WEB_HOOK }} + type: recent + env: + GITHUB_TOKEN: ${{ secrets.GITHUBTOKEN }} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..18c9147181 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..f3b3ce3188 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +## Create pull request +PR are always welcome, even if they only contain small fixes like typos or a few lines of code. If there will be a significant effort, please document it as an issue and get a discussion going before starting to work on it. + +Please submit a PR broken down into small changes bit by bit. A PR consisting of a lot features and code changes may be hard to review. It is recommended to submit PRs in an incremental fashion. + +This [development guideline](https://dataease.io/docs/dev_manual/dev_manual/) contains information about repository structure, how to setup development environment, how to run it, and more. + +Note: If you split your pull request to small changes, please make sure any of the changes goes to master will not break anything. Otherwise, it can not be merged until this feature complete. + +## Report issues +It is a great way to contribute by reporting an issue. Well-written and complete bug reports are always welcome! Please open an issue and follow the template to fill in required information. + +Before opening any issue, please look up the existing issues to avoid submitting a duplication. +If you find a match, you can "subscribe" to it to get notified on updates. If you have additional helpful information about the issue, please leave a comment. + +When reporting issues, always include: + +* Which version you are using. +* Steps to reproduce the issue. +* Snapshots or log files if needed + +Because the issues are open to the public, when submitting files, be sure to remove any sensitive information, e.g. user name, password, IP address, and company name. You can +replace those parts with "REDACTED" or other strings like "****". diff --git a/README.md b/README.md index 1099a7bcf3..32d56e74d8 100644 --- a/README.md +++ b/README.md @@ -7,24 +7,29 @@ Stars Downloads

-
+
+ +## 什么是 DataEase？ + DataEase 是开源的数据可视化分析工具，帮助用户快速分析数据并洞察业务趋势，从而实现业务的改进与优化。DataEase 支持丰富的数据源连接，能够通过拖拉拽方式快速制作图表，并可以方便的与他人分享。 -### DataEase 的功能： +![de-architecture](https://dataease.io/images/screenshot/de-chart-new.jpg) -- 图表展示：支持 PC 端、移动端及大屏; +**DataEase 的功能包括：** + +- 图表展示：支持 PC 端、移动端、大屏; - 图表制作：支持丰富的图表类型(Apache ECharts / AntV)、支持拖拉拽方式快速制作仪表板; - 数据引擎：支持直连模式、本地模式(基于 Apache Doris / Kettle 实现); -- 数据连接：支持关系型数据库、Excel 等文件、Hadoop 等大数据平台、NoSQL 等各种数据源。 +- 数据连接：支持数据仓库/数据湖、OLAP 数据库、OLTP 数据库、Excel 数据文件、API 等各种数据源。 -### DataEase 的优势： +## DataEase 的优势 - 开源开放：零门槛，线上快速获取和安装；快速获取用户反馈、按月发布新版本； - 简单易用：极易上手，通过鼠标点击和拖拽即可完成分析； - 秒级响应：集成 Apache Doris，超大数据量下秒级查询返回延时； - 安全分享：支持多种数据分享方式，确保数据安全。 -### DataEase 已支持的数据源: +## DataEase 支持的数据源 - Excel - MySQL @@ -39,20 +44,20 @@ DataEase 是开源的数据可视化分析工具，帮助用户快速分析数 - Amazon Redshift - Hive - DB2 +- API +- Impala +- TiDB +- StarRocks > 更多数据源支持持续增加中... ## UI 展示 -![de-ui](https://www.fit2cloud.com/dataease/images/screenshot/dataease-v1.gif) - -## 功能架构 - -![de-architecture](https://dataease.oss-cn-hangzhou.aliyuncs.com/img/de-architecture.png) +![de-ui](https://dataease.io/docs/img/index/%E7%95%8C%E9%9D%A2%E5%B1%95%E7%A4%BA.gif) ## 在线体验 -- 环境地址： +- 环境地址： - 用户名：demo - 密码：dataease @@ -68,7 +73,8 @@ curl -sSL https://github.com/dataease/dataease/releases/latest/download/quick_st ``` - [在线文档](https://dataease.io/docs/) -- [演示视频](https://www.bilibili.com/video/BV1i34y1v7hq/) +- [教学视频](https://dataease.io/video.html) +- [在线学习班](https://edu.fit2cloud.com/page/2635362?navIndex=0) ## 微信群 @@ -76,15 +82,16 @@ curl -sSL https://github.com/dataease/dataease/releases/latest/download/quick_st ## 技术栈 +- 前端：[Vue.js](https://vuejs.org/)、[Element](https://element.eleme.cn/) +- 图库：[Apache ECharts](https://github.com/apache/echarts)、[AntV](https://antv.vision/zh) - 后端：[Spring Boot](https://spring.io/projects/spring-boot) -- 前端：[Vue.js](https://vuejs.org/)、[Element](https://element.eleme.cn/)、[Apache ECharts](https://github.com/apache/echarts)、[AntV](https://antv.vision/zh) - 中间件：[MySQL](https://www.mysql.com/) - 数据处理：[Kettle](https://github.com/pentaho/pentaho-kettle)、[Apache Doris](https://github.com/apache/incubator-doris/) - 基础设施：[Docker](https://www.docker.com/) -## License & Copyright +## License -Copyright (c) 2014-2021 飞致云 FIT2CLOUD, All rights reserved. +Copyright (c) 2014-2022 飞致云 FIT2CLOUD, All rights reserved. Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..66aa1f1fe7 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,19 @@ +# 安全说明 + +如果您发现安全问题，请直接联系我们： + +- wei@fit2cloud.com +- support@fit2cloud.com +- 400-052-0755 + +感谢您的支持！ + +# Security Policy + +All security bugs should be reported to the contact as below: + +- wei@fit2cloud.com +- support@fit2cloud.com +- 400-052-0755 + +Thanks for you support!