diff --git a/doc/docs/.vuepress/config.js b/doc/docs/.vuepress/config.js index b713d6d7..d87b96f7 100644 --- a/doc/docs/.vuepress/config.js +++ b/doc/docs/.vuepress/config.js @@ -14,15 +14,27 @@ module.exports = { {text: '指南', link: '/guide/'}, {text: 'GitHub', link: 'https://github.com/anji-plus/report'}, {text: 'Gitee', link: 'https://gitee.com/anji-plus/report'}, + {text: '谁在使用', link: '/guide/briefUsing'}, ], sidebar: { '/guide/': [ { - title: '文档', + title: '介绍', collapsable: false, children: [ - {title: '介绍', path: '/guide/'}, - {title: '快速入门', path: '/guide/quickly'}, + {title: '简介', path: '/guide/'}, + {title: '谁在使用', path: '/guide/briefUsing'}, + {title: '技术支持', path: '/guide/briefSupport'}, + ] + }, + { + title: '快速入门', + collapsable: false, + children: [ + {title: '开发环境', path: '/guide/quicklyDevelop'}, + {title: '发行版部署', path: '/guide/quicklyDistribution'}, + {title: '源码部署', path: '/guide/quicklySource'}, + {title: '前后端分离', path: '/guide/quicklySeparate'}, ] }, { diff --git a/doc/docs/guide/README.md b/doc/docs/guide/README.md index da83e41c..b424a322 100644 --- a/doc/docs/guide/README.md +++ b/doc/docs/guide/README.md @@ -1,7 +1,12 @@ -## 简介     AJ-Report是一个完全开源的BI平台，酷炫大屏展示，能随时随地掌控业务动态，让每个决策都有数据支撑。
-    多数据源支持，内置mysql、elasticsearch、kudu驱动，支持自定义数据集省去数据接口开发，支持17种大屏组件，不会开发，照着设计稿也可以制作大屏。
+    多数据源支持，内置mysql、elasticsearch、kudu驱动，支持自定义数据集省去数据接口开发，支持17种+大屏组件，不会开发，照着设计稿也可以制作大屏。
    三步轻松完成大屏设计：配置数据源---->写SQL配置数据集---->拖拽配置大屏---->保存发布。欢迎体验。 + +## 系统特性 +1. 最新最稳定的技术栈； +2. 支持多数据源配置 +3. 丰富的大屏组件。拖拽配置实现动态大屏 + ## 在线体验 ####   电脑在线体验: [https://report.anji-plus.com/index.html](https://report.anji-plus.com/index.html "链接")  体验账号：guest 密码：guest ####   在线文档: [https://report.anji-plus.com/report-doc/](https://report.anji-plus.com/report-doc/ "doc")
@@ -15,12 +20,12 @@    大屏设计（AJ-Report）是一个可视化拖拽编辑的，直观，酷炫，具有科技感的图表工具全开源项目。 内置的基础功能包括数据源，数据集，报表管理，项目部分截图如下。
**在线案例还在努力创造中，敬请期待！！！** -![操作](https://images.gitee.com/uploads/images/2021/0703/094742_c0243f70_1728982.gif "2021-07-03_09-43-50.gif") +![操作](../picture/shipin.gif) ## 数据流程图 -![An image](https://images.gitee.com/uploads/images/2021/0630/160451_31bb9052_1728982.png) +![流程.png](../picture/liucheng.png) -## 打包目录build +## 打包目录 ``` ├── bin 启动命令脚本 │ ├── restart.sh @@ -49,17 +54,6 @@ ├── README.md ``` -## 近期计划 -- 完善地图插件 -- 完善表格插件 -- 丰富自定义框图、挂件 -- 丰富更多图表组件 - -## 技术支持 -**如有问题，请提交 [Issue](https://gitee.com/anji-plus/report/issues)
** -微信群：
- -#### 开源不易，劳烦各位star ☺ diff --git a/doc/docs/guide/briefSupport.md b/doc/docs/guide/briefSupport.md new file mode 100644 index 00000000..9150a356 --- /dev/null +++ b/doc/docs/guide/briefSupport.md @@ -0,0 +1,6 @@ +**如有问题，请提交 [Issue](https://gitee.com/anji-plus/report/issues)
** + +**微信群:
** +![weixin.png](../picture/weixin.jpeg) + +#### 开源不易，劳烦各位star ☺ \ No newline at end of file diff --git a/doc/docs/guide/briefUsing.md b/doc/docs/guide/briefUsing.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/docs/guide/quickly.md b/doc/docs/guide/quicklyDevelop.md similarity index 64% rename from doc/docs/guide/quickly.md rename to doc/docs/guide/quicklyDevelop.md index a076ccaa..a7fa2a11 100644 --- a/doc/docs/guide/quickly.md +++ b/doc/docs/guide/quicklyDevelop.md @@ -1,40 +1,7 @@ -## 快速部署 -下载地址：[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases) -```js - 第一步，下载zip包，解压
- 第二步，conf->bootstrap-dev.yml，修改mysql连接
- 第三步，启动bin目录下start.sh
- 第四步，访问 http://localhost:9095/index.html -``` - -## 编译打包 -在Linux上先准备好maven、node.js、jdk -- [Apache Maven] 3.5 +
-- [Node.js] v14.16.0+
-- [Jdk] 1.8+ -``` -git clone https://gitee.com/anji-plus/report.git -cd report -sh build.sh -编译完成放在build文件夹 report-core-xxxx.zip - -unzip report-core-xxxx.zip -cd report-core-xxxx -vim conf/bootstrap-dev.yml 数据库连接、上传文件的路径以及地址修改 -sh bin/start.sh - -启动后访问 -http://serverip:9095 -``` - -也可以前后端分开单独部署，前端部署nginx，后端jar - -## 系统特性 -1. 最新最稳定的技术栈； -2. 支持多数据源配置 -3. 丰富的大屏组件。拖拽配置实现动态大屏 - ## 核心技术 +### 底层依赖 +- [Mysql] 5.7 +- [Jdk] 1.8 ### 后端 - [Spring Boot](https://spring.io/projects/spring-boot/): Spring Boot是一款开箱即用框架，让我们的Spring应用变的更轻量化、更快的入门。 在主程序执行main函数就可以运行。你也可以打包你的应用为jar并通过使用java -jar来运行你的Web应用； - [Mybatis-plus](https://mp.baomidou.com/): MyBatis-plus（简称 MP）是一个 MyBatis (opens new window) 的增强工具。 @@ -47,5 +14,18 @@ http://serverip:9095 - [vue-router](https://router.vuejs.org/)： Vue提供的前端路由工具，利用其我们实现页面的路由控制，局部刷新及按需加载，构建单页应用，实现前后端分离。 - [vuex](https://vuex.vuejs.org/)：Vue提供的状态管理工具，用于统一管理我们项目中各种数据的交互和重用，存储我们需要用到数据对象。 - [element-ui](https://element.eleme.cn/#/zh-CN)：基于MVVM框架Vue开源出来的一套前端ui组件。 -- [avue](https://www.avuejs.com/): 用该组件包裹后可以变成拖拽组件,采用相对于父类绝对定位;用键盘的上下左右也可以控制移动 +- [avue](https://www.avuejs.com/): 用该组件包裹后可以变成拖拽组件,采用相对于父类绝对定位;用键盘的上下左右也可以控制移 + +## 开发环境 +这里提供我们的开发环境版本进行参考 +- [CentOs] 7.5 +- [Mysql] 5.7 +- [Jdk] 1.8 +- [Spring Boot] 2.3.5 +- [Mybatis-plus] 3.3.2 +- [flyway] 5.2.1 +- [Apache Maven] 3.5 +- [Node.js] 14.16.0 +- [Windows 10] +已知 **Mysql8.0** 和 **Jdk11** 会出现兼容性问题，后续有解决方法将会在下方 **其他** 大类进行补充 \ No newline at end of file diff --git a/doc/docs/guide/quicklyDistribution.md b/doc/docs/guide/quicklyDistribution.md new file mode 100644 index 00000000..825ec851 --- /dev/null +++ b/doc/docs/guide/quicklyDistribution.md @@ -0,0 +1,40 @@ +``` + 第一步，下载zip包，解压
+ 第二步，conf->bootstrap-dev.yml，修改mysql连接
+ 第三步，启动bin目录下start.sh
+ 第四步，访问 http://localhost:9095/index.html +``` + +## 下载发行版 +下载地址：[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases) +![img.png](../picture/quickly/img.png) + +## 修改mysql连接 +解压下载好的Zip包，找到bootstrap-dev.yml
+report-core-XXX --> conf --> bootstrap-dev.yml
+![img_1.png](../picture/quickly/img_1.png) + +将图中关于mysql的连接配置信息换成你使用的IP
+**注**：aj_report库是存放底层基础信息的库，flyway启动时会自动建立，如果你在这里修改了库，将会出错
+![bootstrap.png](../picture/quickly/img_2.png) + +## 修改路径 +使用上传功能，必须修改此内容 +![file.png](../picture/quickly/img_5.png) + +## 启动 +linux启动：report-core-XXX --> bin --> start.sh
+windows启动：report-core-XXX --> bin --> start.bat
+**注**：beta.4版本的start.bat脚本有问题，会提示无法找到主类，请将脚本中的“-Xbootclasspath/a:%LIB_JARS% %JAVA_OPTS%”剪切放置后面
+![img_3.png](../picture/quickly/img_3.png) +如果仍然有问题，请换成start.sh启动 +**注**：脚本目前没有校验是否有Jdk、Mysql + + +## 访问 +http://localhost:9095/index.html
+默认密码：admin 123456 + + + + diff --git a/doc/docs/guide/quicklySeparate.md b/doc/docs/guide/quicklySeparate.md new file mode 100644 index 00000000..e69de29b diff --git a/doc/docs/guide/quicklySource.md b/doc/docs/guide/quicklySource.md new file mode 100644 index 00000000..b27af504 --- /dev/null +++ b/doc/docs/guide/quicklySource.md @@ -0,0 +1,43 @@ +``` +git clone https://gitee.com/anji-plus/report.git +cd report +sh build.sh +编译完成放在build文件夹 report-core-xxxx.zip + +unzip report-core-xxxx.zip +cd report-core-xxxx +vim conf/bootstrap-dev.yml 数据库连接、上传文件的路径以及地址修改 +sh bin/start.sh +``` + +## 编译环境 +请在Linux上先准备好maven、node.js、jdk +- [Apache Maven] 3.5 +
+- [Node.js] v14.16.0+
+- [Jdk] 1.8
+**注**：已知**Jdk11**存在兼容性问题 + +## 克隆源码 +git clone https://gitee.com/anji-plus/report.git
+ +## build +进入report目录，启动build.sh +![img_4.png](../picture/quickly/img_4.png) +编译完成后是放在当前目录下的build文件夹中：report-core-xxxx.zip
+**注**：脚本目前没有校验是否有Jdk、Git、Node.js + +## 解压，修改mysql连接 +![img_1.png](../picture/quickly/img_1.png) + +## 修改路径 +使用上传功能，必须修改此内容 +![file.png](../picture/quickly/img_5.png) + +## 启动 +report-core-XXX --> bin --> start.sh
+sh bin/start.sh
+**注**：脚本目前没有校验是否有Jdk、Mysql + +## 访问 +http://serverip:9095
+默认密码：admin 123456 diff --git a/doc/docs/picture/img_1.png b/doc/docs/picture/img_1.png deleted file mode 100644 index 6fd598f4..00000000 Binary files a/doc/docs/picture/img_1.png and /dev/null differ diff --git a/doc/docs/picture/流程.png b/doc/docs/picture/liucheng.png similarity index 100% rename from doc/docs/picture/流程.png rename to doc/docs/picture/liucheng.png diff --git a/doc/docs/picture/quickly/img.png b/doc/docs/picture/quickly/img.png new file mode 100644 index 00000000..486d1da9 Binary files /dev/null and b/doc/docs/picture/quickly/img.png differ diff --git a/doc/docs/picture/quickly/img_1.png b/doc/docs/picture/quickly/img_1.png new file mode 100644 index 00000000..d741757f Binary files /dev/null and b/doc/docs/picture/quickly/img_1.png differ diff --git a/doc/docs/picture/quickly/img_2.png b/doc/docs/picture/quickly/img_2.png new file mode 100644 index 00000000..3f2e355a Binary files /dev/null and b/doc/docs/picture/quickly/img_2.png differ diff --git a/doc/docs/picture/quickly/img_3.png b/doc/docs/picture/quickly/img_3.png new file mode 100644 index 00000000..3e9fd0df Binary files /dev/null and b/doc/docs/picture/quickly/img_3.png differ diff --git a/doc/docs/picture/quickly/img_4.png b/doc/docs/picture/quickly/img_4.png new file mode 100644 index 00000000..bc59e256 Binary files /dev/null and b/doc/docs/picture/quickly/img_4.png differ diff --git a/doc/docs/picture/quickly/img_5.png b/doc/docs/picture/quickly/img_5.png new file mode 100644 index 00000000..f2bcbc05 Binary files /dev/null and b/doc/docs/picture/quickly/img_5.png differ diff --git a/doc/docs/picture/shipin.gif b/doc/docs/picture/shipin.gif new file mode 100644 index 00000000..66da8ba8 Binary files /dev/null and b/doc/docs/picture/shipin.gif differ diff --git a/doc/docs/picture/weixin.jpeg b/doc/docs/picture/weixin.jpeg new file mode 100644 index 00000000..342096e4 Binary files /dev/null and b/doc/docs/picture/weixin.jpeg differ