From c8cc37bf23f7b03d1f1983cd7f91589c9d0305ce Mon Sep 17 00:00:00 2001 From: wanghe-fit2cloud Date: Thu, 5 Dec 2024 22:17:08 +0800 Subject: [PATCH] feat: Add English README --- README.md | 3 ++- README_EN.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 README_EN.md diff --git a/README.md b/README.md index 2d026d7c75..9acf004b39 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ License: GPL v3 Codacy GitHub Stars - Gitee Stars + Gitee Stars
+ [中文(简体)] | [English]

------------------------------ diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000000..3e40168d82 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,64 @@ +

DataEase

+

An Open-Source BI Tool for Everyone

+

+ License: GPL v3 + Codacy + GitHub Stars + Gitee Stars
+ [English] | [中文(简体)] +

+ +------------------------------ + +## What is DataEase? + +DataEase is an open-source BI tool designed to help users quickly analyze data and gain business insights, enabling them to improve and optimize their operations. It supports a wide range of data sources, allowing users to create charts with a simple drag-and-drop interface and share them effortlessly. + +**Advantages of DataEase:** + +- Open Source: Zero barriers, fast online acquisition and installation, monthly updates. +- User-Friendly: Easy to use; analysis can be completed with simple mouse clicks and drag-and-drop actions. +- Versatile: Supports multi-platform installation and diversified embedding options. +- Secure Sharing: Offers various data-sharing methods while ensuring data security. + +**Supported Data Sources:** + +- OLTP Databases: MySQL, Oracle, SQL Server, PostgreSQL, MariaDB, Db2, TiDB, MongoDB-BI, etc. +- OLAP Databases: ClickHouse, Apache Doris, Apache Impala, StarRocks, etc. +- Data Warehouses/Data Lakes: Amazon RedShift, etc. +- Data Files: Excel, CSV, etc. +- API Data Sources. + +## Quick Start + +``` +# Prepare a Linux server with at least 2 CPUs and 4GB of RAM, then run the following one-click installation script as the root user: + +curl -sSL https://dataease.oss-cn-hangzhou.aliyuncs.com/quick_start_v2.sh | bash + +# Username: admin +# Password: DataEase@123456 +``` + +## Technology Stack + +- Frontend: [Vue.js](https://vuejs.org/), [Element](https://element.eleme.cn/) +- Visualization Library: [AntV](https://antv.vision/zh) +- Backend: [Spring Boot](https://spring.io/projects/spring-boot) +- Database: [MySQL](https://www.mysql.com/) +- Data Processing: [Apache Calcite](https://github.com/apache/calcite/), [Apache SeaTunnel](https://github.com/apache/seatunnel) +- Infrastructure: [Docker](https://www.docker.com/) + +## Security + +If you discover any security issues, please contact us through: wei@fit2cloud.com. + +## License + +Copyright (c) 2014-2024 [FIT2CLOUD](https://fit2cloud.com/), 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 + + + +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.