From 521a65f5201fc4c0a1b8b7886d9dbe18b6bb010b Mon Sep 17 00:00:00 2001 From: qianming Date: Wed, 17 May 2023 14:59:47 +0800 Subject: [PATCH] =?UTF-8?q?doc=E6=96=87=E6=A1=A3=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 87 ++++++++++++++++++--------- doc/docs/.vuepress/config.js | 4 +- doc/docs/guide/README.md | 10 ++- doc/docs/guide/bigScreenCase.md | 11 ++-- doc/docs/guide/quicklyDevelop.md | 14 +++-- doc/docs/guide/quicklyDistribution.md | 22 ++++--- doc/docs/guide/quicklySeparate.md | 34 +++++++---- doc/docs/guide/quicklySource.md | 20 +++--- 8 files changed, 124 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 97f3dfae..ca6c548f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ ## 简介     AJ-Report是全开源的一个BI平台，酷炫大屏展示，能随时随地掌控业务动态，让每个决策都有数据支撑。
-    多数据源支持，内置mysql、elasticsearch、kudu驱动，支持自定义数据集省去数据接口开发，目前已支持25种大屏组件/图表，不会开发，照着设计稿也可以制作大屏。
+    +多数据源支持，内置mysql、elasticsearch、kudu驱动，支持自定义数据集省去数据接口开发，目前已支持30+种大屏组件/图表，不会开发，照着设计稿也可以制作大屏。
    三步轻松完成大屏设计：配置数据源---->写SQL配置数据集---->拖拽配置大屏---->保存发布。欢迎体验。 ## 在线体验 @@ -20,11 +21,13 @@ ####   组件介绍 -   大屏设计（AJ-Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具全开源项目。 内置的基础功能包括数据源，数据集，报表管理，项目部分截图如下。
+   大屏设计（AJ-Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具全开源项目。 +内置的基础功能包括数据源，数据集，报表管理，项目部分截图如下。
![操作](https://images.gitee.com/uploads/images/2021/0703/094742_c0243f70_1728982.gif "2021-07-03_09-43-50.gif") -![视频](https://ajreport.beliefteam.cn/report-doc/static/Rhea.mp4)
-**[更多社区大屏案例](https://ajreport.beliefteam.cn/report-doc/guide/bigScreenCase.html)**
+ +**[更多社区大屏](https://ajreport.beliefteam.cn/report-doc/guide/bigScreenCase.html)**
+**[社区大屏下载链接](https://ajreport.beliefteam.cn/download/)**
## 数据流程图 @@ -96,12 +99,15 @@ 源码 doc -> docs -> guide 目录下即所有文档
### 发行版部署 -**[发行版部署参考文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklyDistribution.html)**
+ +**[发行版部署详细文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklyDistribution.html)**
+ +简易步骤 ``` 下载最新发行版，解压 cd aj-report-xxxx -vim conf/bootstrap.yml 修改数据库连接等信息 +vim conf/bootstrap.yml 修改数据库连接、上传下载地址等信息 sh bin/start.sh Linux启动 bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释)，双击启动 @@ -109,11 +115,11 @@ bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释)，双击启 http://serverip:9095 用户名密码：admin/123456 -登陆后修改"数据源->mysql数据源"用户名密码 ``` ### 源码编译部署 -**[源码编译部署参考文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklySource.html)**
+ +**[源码编译部署详细文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklySource.html)**
在Linux上先准备好maven、node.js、jdk @@ -121,6 +127,8 @@ http://serverip:9095 - [Node.js] v14.16.0
- [Jdk] 1.8 +简易步骤 + ``` git clone https://gitee.com/anji-plus/report.git cd report @@ -129,7 +137,7 @@ sh build.sh unzip aj-report-xxxx.zip cd aj-report-xxxx -vim conf/bootstrap.yml 修改数据库连接等信息 +vim conf/bootstrap.yml 修改数据库连接、上传下载地址等信息 sh bin/start.sh Linux启动 bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释)，双击启动 @@ -137,7 +145,6 @@ bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释)，双击启 http://serverip:9095 用户名密码：admin/123456 -登陆后修改"数据源->mysql数据源"用户名密码 ``` **[前后端分离部署参考文档](https://ajreport.beliefteam.cn/report-doc/guide/quicklySeparate.html)**
@@ -150,13 +157,13 @@ http://serverip:9095 ## SQL初始化 sql文件的目录在：report-core --> src --> main --> resources -- > db.migration
- -系统初始化时flyway会自动的将该目录下的sql文件执行，不需要手动执行sql文件。
-执行完将会创建 aj_report（存放系统基础数据） 和 aj_report_init（存放示例数据） 俩个库。
+系统初始化时flyway会自动的将该目录下的sql文件执行，不需要手动执行sql文件，执行完将会创建 +aj_report（存放系统基础数据）数据库
## 谁在使用 -希望你们的logo出现在此，[请点此Issue进行登记](https://gitee.com/anji-plus/report/issues/I3ZXT4) ，我们将优先进行技术支持
+感谢关注并使用AJ-Report的朋友，如果贵公司、组织、学校等正在使用AJ-Report，希望可以按照此[Issue](https://gitee.com/anji-plus/report/issues/I3ZXT4) +登记并提供贵公司、组织、学校的logo，我们将把贵方的logo放在项目首页进行展示并优先进行技术支持
@@ -170,14 +177,8 @@ sql文件的目录在：report-core --> src --> main --> resources -- > db.migra
- -## 未来计划 - -- 大屏宽高动态可视化 -- nodeV16适配 -- 增加省市区地图等图 -- 增加基础边框样式 -- Excel报表功能增加与bug修复 + +
## 已知问题 @@ -189,31 +190,57 @@ sql文件的目录在：report-core --> src --> main --> resources -- > db.migra - Node.js V16及以上 - openJdk -- Jdk 1.7及以下/11及以上 +- Jdk 1.7及以下/11及以上（jdk11部分版本有问题） - Mysql 8.0（8.0.23/26版本没有问题，8.0.21版本存在问题） **[常见问题](https://ajreport.beliefteam.cn/report-doc/guide/question.html)** ## 商业授权 -AJ-Report使用[Apache2.0开源协议](http://www.apache.org/licenses/LICENSE-2.0.html)
+AJ-Report使用[Apache2.0开源协议](http://www.apache.org/licenses/LICENSE-2.0.html)，允许商业使用，但务必保留类作者、Copyright信息。
个人和企业，在直接使用、二次开发后商业使用，需要遵守： - 包含AJ-Report LICENSE文件（授权使用者免费使用AJ-Report专利和知识产权） - 如果修改了代码，需要在被修改的文件中说明 - 在修改和有源代码衍生的代码中，需要带有原来代码中的协议，商标 -- 在二次开发后商业发布的产品中，使用了多个开源软件，则必须包含一个Notice文件，在Notice文件中需要带有AJ-Report LICENSE。你可以在Notice中增加自己的许可，但不可以表现为对AJ-Report +- 在二次开发后商业发布的产品中，使用了多个开源软件，则必须包含一个Notice文件，在Notice文件中需要带有AJ-Report + LICENSE。你可以在Notice中增加自己的许可，但不可以表现为对AJ-Report LICENSE构成更改。 -如果您需要商业化增值服务，请加下面的微信沟通，并直接说明来意。 - ## 技术支持 **如有问题，请提交 [Issue](https://gitee.com/anji-plus/report/issues)
** -个人企业微信：加微信进群备注 AJ-Report 或者 Report
-如果不是为了进群，请直接说明来意，每天加群的都很多，企微也是我们自己的工作企微，会有很多消息会被刷下去，如果半天没有回复你，请发送多次。如果加了之后一言不发，不好意思，我直接忽略，我也不知道你要干嘛。
- +个人企业微信：加微信进群备注 **AJ-Report** 或者 **Report**，**一定要加备注 ！！！**
+如果不是为了进群，请直接说明来意，每天加群的都很多，企微也是我们自己的工作企微，会有很多消息会被刷下去，如果半天没有回复你，请过段时间再发送。
+ + +## 更多支持 + +联系方式
+ + + +## 加入我们 + +- 提交PR是最快的加入方式:
+ · PR可以包含新功能、现有功能的改进。
+ . PR请提交到dev分支
+- 提供文档原文或者文档链接:
+ . 文档原文的话，请放在doc/docs/guide/community目录下，可直接提交pr
+ . 文档链接的话，文档需要完全的公开，不掺杂收费等相关内容，审核通过会放在首页
+- 提供大屏模板:
+ . 可将自己设计好的大屏进行导出(不包含数据集)，将导出产生的压缩包提供给我们（加个人企微）
+ . 提供的大屏将会在AJ-Report在线演示环境进行展示和供其他人下载
#### 开源不易，劳烦各位star ☺ +## 感谢JetBrains 的支持 + +#### JetBrains:[https://www.jetbrains.com/?from=AJ-Report](https://www.jetbrains.com/?from=AJ-Report"链接") + +
+ +## Stargazers over time + +[![Stargazers over time](https://starchart.cc/anji-plus/report.svg)](https://starchart.cc/anji-plus/report) diff --git a/doc/docs/.vuepress/config.js b/doc/docs/.vuepress/config.js index b0bc52f7..97865c9d 100644 --- a/doc/docs/.vuepress/config.js +++ b/doc/docs/.vuepress/config.js @@ -15,7 +15,7 @@ module.exports = { {text: 'GitHub', link: 'https://github.com/anji-plus/report'}, {text: 'Gitee', link: 'https://gitee.com/anji-plus/report'}, {text: '谁在使用', link: '/guide/briefUsing'}, - {text: '更多案例', link: '/guide/bigScreenCase'}, + {text: '更多大屏', link: '/guide/bigScreenCase'}, ], sidebar: { '/guide/': [ @@ -26,7 +26,7 @@ module.exports = { {title: '简介', path: '/guide/'}, {title: '谁在使用', path: '/guide/briefUsing'}, {title: '技术支持', path: '/guide/briefSupport'}, - {title: '更多案例', path: '/guide/bigScreenCase'}, + {title: '更多大屏', path: '/guide/bigScreenCase'}, ] }, { diff --git a/doc/docs/guide/README.md b/doc/docs/guide/README.md index ef54e6f9..7e6af66d 100644 --- a/doc/docs/guide/README.md +++ b/doc/docs/guide/README.md @@ -1,10 +1,13 @@ +## 简介 +     AJ-Report是一个完全开源的BI平台，酷炫大屏展示，能随时随地掌控业务动态，让每个决策都有数据支撑。
-    多数据源支持，内置mysql、elasticsearch、kudu等多种驱动，支持自定义数据集省去数据接口开发，目前已支持20种大屏组件/图表，不会开发，照着设计稿也可以制作大屏。
+    +多数据源支持，内置mysql、elasticsearch、kudu等多种驱动，支持自定义数据集省去数据接口开发，目前已支持30+种大屏组件/图表，不会开发，照着设计稿也可以制作大屏。
    三步轻松完成大屏设计：配置数据源---->写SQL配置数据集---->拖拽配置大屏---->保存发布。欢迎体验。 ## 系统特性 -1. 最新最稳定的技术栈； +1. 最新最稳定的技术栈 2. 支持多数据源配置 3. 丰富的大屏组件。拖拽配置实现动态大屏 @@ -22,7 +25,8 @@ ####   组件介绍 -   大屏设计（AJ-Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具全开源项目。 内置的基础功能包括数据源，数据集，报表管理，项目部分截图如下。
+   大屏设计（AJ-Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具全开源项目。 +内置的基础功能包括数据源，数据集，报表管理，项目部分截图如下。
![shipin](../picture/shipin.gif) diff --git a/doc/docs/guide/bigScreenCase.md b/doc/docs/guide/bigScreenCase.md index ed268294..df12714f 100644 --- a/doc/docs/guide/bigScreenCase.md +++ b/doc/docs/guide/bigScreenCase.md @@ -1,13 +1,13 @@ -## 案例一 +## 社区提供 + +### **[~无痕~@tengzhouboy](https://gitee.com/tengzhouboy)** 提供
-由社区 **[~无痕~@tengzhouboy](https://gitee.com/tengzhouboy)** 提供
[AJ-Report分享链接](https://ajreport.beliefteam.cn/index.html#/aj/mtwbjPot)
![img.png](../picture/bigScreenCase/img.png)
-## 案例二 +### **[心瘾丶 @yi_shan_liu](https://gitee.com/yi_shan_liu)** 提供
-由社区 **[心瘾丶 @yi_shan_liu](https://gitee.com/yi_shan_liu)** 提供
[AJ-Report分享链接](https://ajreport.beliefteam.cn/index.html#/aj/hkBJgLW0)
![img1](../picture/bigScreenCase/img1.png)
@@ -21,11 +21,12 @@ [AJ-Report分享链接](https://ajreport.beliefteam.cn/index.html#/aj/D0cpO4re)
![img4](../picture/bigScreenCase/img4.png)
-## 案例下载 +## 大屏下载 **注：在线体验环境因为服务器配置问题，点击导出反应较慢，因此推荐直接下载你想要的大屏zip包即可**
- 通过[下载链接](https://ajreport.beliefteam.cn/download/)下载
+ 1、下载对应大屏的zip包
![img1](../picture/bigScreenCase/img_1.png)
![img2](../picture/bigScreenCase/img_2.png)
diff --git a/doc/docs/guide/quicklyDevelop.md b/doc/docs/guide/quicklyDevelop.md index b43c2cdc..33c4c4ec 100644 --- a/doc/docs/guide/quicklyDevelop.md +++ b/doc/docs/guide/quicklyDevelop.md @@ -37,17 +37,19 @@ - [Node.js] 14.16.0 - [Windows 10] -已知 **Mysql8.0** 部分小版本会出现兼容性问题，后续有解决方法将会在下方 **其他** 大类进行补充 +## 版本问题 -## 不支持的版本 +已知以下版本存在兼容性问题，请不要使用 -- [JDK] 1.7及以下/11及以上 -- [Node.js] V16及以上 +- Node.js V16及以上 +- openJdk +- Jdk 1.7及以下/11及以上（jdk11部分版本有问题） +- Mysql 8.0（8.0.23/26版本没有问题，8.0.21版本存在问题） ## SQL初始化 sql文件的地址是：report-core --> src --> main --> resources -- > db.migration
![sql](../picture/quickly/img_13.png) -系统初始化时flyway会自动的将该目录下的sql文件执行，不需要手动执行sql文件。
-执行完将会创建 aj_report（存放系统基础数据） 和 aj_report_init（存放示例数据） 俩个库。
+系统初始化时flyway会自动的将该目录下的sql文件执行，不需要手动执行sql文件，执行完将会创建 +aj_report（存放系统基础数据）数据库
diff --git a/doc/docs/guide/quicklyDistribution.md b/doc/docs/guide/quicklyDistribution.md index dc8a65c1..8b79e53d 100644 --- a/doc/docs/guide/quicklyDistribution.md +++ b/doc/docs/guide/quicklyDistribution.md @@ -1,11 +1,19 @@ ``` 第一步，下载zip包，解压 - 第二步，conf->bootstrap.yml，修改mysql连接等信息 + 第二步，conf->bootstrap.yml，修改数据库连接、上传下载地址等信息 第三步，启动bin目录下start.sh 第四步，访问 http://localhost:9095 admin 123456 - 第五步，修改"数据源->mysql数据源"用户名密码 ``` +## 版本问题 + +已知以下版本存在兼容性问题，请不要使用 + +- Node.js V16及以上 +- openJdk +- Jdk 1.7及以下/11及以上（jdk11部分版本有问题） +- Mysql 8.0（8.0.23/26版本没有问题，8.0.21版本存在问题） + ## 下载发行版 [下载地址](https://gitee.com/anji-plus/report/releases) ：https://gitee.com/anji-plus/report/releases
@@ -39,18 +47,12 @@ aj-report-XXX --> bin --> start.bat
如果start.bat启动有问题的话，可以尝试以下方法解决。
修改第4行的JAVA_HOME，改成你自己的JAVA_HOME，并去掉**rem**注释，双击启动
-![java.png](../picture/quickly/img_7.png) +![java.png](../picture/quickly/img_7.png) ## 访问 http://localhost:9095
-默认密码：admin 123456
- -## 重置mysql连接 +默认密码：admin 123456
-登陆进来后请修改mysql数据源
-数据源 --> mysql数据源 --> 编辑 --> 修改用户名密码（改成你自己系统mysql的用户名密码）
-![img](../picture/quickly/img_14.png)
-![img_6.png](../picture/quickly/img_6.png)
diff --git a/doc/docs/guide/quicklySeparate.md b/doc/docs/guide/quicklySeparate.md index 52cee76b..782eb018 100644 --- a/doc/docs/guide/quicklySeparate.md +++ b/doc/docs/guide/quicklySeparate.md @@ -1,18 +1,21 @@ -**前后端分离：**
-**请对自己有动手能力的小伙伴进行尝试**
-**请根据自己的实际情况对下面的步骤和内容进行调整**
+**前后端分离部署** + +- 需要有一定的动手能力和排错能力 +- 需要对nginx有一定了解 +- 同一台机器部署前后端真心不需要分离部署 +- **请根据自己的实际情况对下面的步骤和内容进行调整** ``` linux： git clone https://gitee.com/anji-plus/report.git -后端：report-code ： -修改bootstrap.yml +后端：report-code +修改bootstrap.yml 修改数据库连接、上传下载地址等信息 maven package java -jar -前端：report-ui ： +前端：report-ui 修改前端config连接 -BASE_API: '"./"'，改成自己后端的api +BASE_API: '"./"'，改成自己后端服务所在机器的ip地址 npm install npm run build @@ -27,7 +30,14 @@ npm run build - [Node.js] v14.16.0
- [Jdk] 1.8
-**注**：已知 **Jdk11** (部分小版本)存在兼容性问题，请不要使用openJdk，环境问题请看 **常见问题** 大类
+## 版本问题 + +已知以下版本存在兼容性问题，请不要使用 + +- Node.js V16及以上 +- openJdk +- Jdk 1.7及以下/11及以上（jdk11部分版本有问题） +- Mysql 8.0（8.0.23/26版本没有问题，8.0.21版本存在问题） ### 克隆源码 @@ -72,9 +82,9 @@ OSS底层已支持minio、amazonS3、nfs，都配置的情况下优先级minio-> 将上步生成的jar包上传至linux，使用java -jar命令启动
**注**：请确保你的linux有jdk1.8
-## 前端build +## 前端编译 -### 前端编译 +### install 进入前端目录：report-ui
![img11](../picture/quickly/img_11.png)
@@ -83,9 +93,9 @@ OSS底层已支持minio、amazonS3、nfs，都配置的情况下优先级minio-> ### 修改config 目录地址：report-ui --> config --> prod.env.js
-将BASE_API地址，改成你后端的api地址
+将BASE_API地址，改成自己后端服务所在机器的ip地址
-### 打包 +### build 执行 npm run build
diff --git a/doc/docs/guide/quicklySource.md b/doc/docs/guide/quicklySource.md index 484037e7..8865e01c 100644 --- a/doc/docs/guide/quicklySource.md +++ b/doc/docs/guide/quicklySource.md @@ -6,13 +6,11 @@ sh build.sh unzip aj-report-xxxx.zip cd aj-report-xxxx -vim conf/bootstrap.yml 修改数据库连接、上传文件的路径以及地址 +vim conf/bootstrap.yml 修改数据库连接、上传下载地址等信息 sh bin/start.sh 访问：http://serverip:9095 admin 123456 - -修改："数据源->mysql数据源"用户名密码 ``` ## 编译环境 @@ -24,7 +22,15 @@ admin 123456 - [Apache Maven] 3.5
- [Node.js] v14.16.0
- [Jdk] 1.8
- **注**：已知**Jdk11**存在兼容性问题，请不要使用openJdk，环境问题请看 **常见问题** 大类
+ +## 版本问题 + +已知以下版本存在兼容性问题，请不要使用 + +- Node.js V16及以上 +- openJdk +- Jdk 1.7及以下/11及以上（jdk11部分版本有问题） +- Mysql 8.0（8.0.23/26版本没有问题，8.0.21版本存在问题） ## 克隆源码 @@ -78,10 +84,4 @@ aj-report-XXX --> bin --> start.bat
http://serverip:9095
默认密码：admin 123456
-## 重置mysql连接 - -登陆进来后请修改mysql数据源
-数据源 --> mysql数据源 --> 编辑 --> 修改用户名密码（改成你自己系统mysql的用户名密码）
-![img](../picture/quickly/img_14.png)
-![img_6.png](../picture/quickly/img_6.png)