doc更新
@@ -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'},
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
@@ -1,7 +1,12 @@
|
||||
## 简介
|
||||
    AJ-Report是一个完全开源的BI平台,酷炫大屏展示,能随时随地掌控业务动态,让每个决策都有数据支撑。<br>
|
||||
    多数据源支持,内置mysql、elasticsearch、kudu驱动,支持自定义数据集省去数据接口开发,支持17种大屏组件,不会开发,照着设计稿也可以制作大屏。<br>
|
||||
    多数据源支持,内置mysql、elasticsearch、kudu驱动,支持自定义数据集省去数据接口开发,支持17种+大屏组件,不会开发,照着设计稿也可以制作大屏。<br>
|
||||
    三步轻松完成大屏设计:配置数据源---->写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")<br>
|
||||
@@ -15,12 +20,12 @@
|
||||
   大屏设计(AJ-Report)是一个可视化拖拽编辑的,直观,酷炫,具有科技感的图表工具全开源项目。
|
||||
内置的基础功能包括数据源,数据集,报表管理,项目部分截图如下。<br>
|
||||
**在线案例还在努力创造中,敬请期待!!!**
|
||||

|
||||

|
||||
|
||||
## 数据流程图
|
||||

|
||||

|
||||
|
||||
## 打包目录build
|
||||
## 打包目录
|
||||
```
|
||||
├── bin 启动命令脚本
|
||||
│ ├── restart.sh
|
||||
@@ -49,17 +54,6 @@
|
||||
├── README.md
|
||||
```
|
||||
|
||||
## 近期计划
|
||||
- 完善地图插件
|
||||
- 完善表格插件
|
||||
- 丰富自定义框图、挂件
|
||||
- 丰富更多图表组件
|
||||
|
||||
## 技术支持
|
||||
**如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
|
||||
微信群:<br>
|
||||
<img src="https://images.gitee.com/uploads/images/2021/0707/154657_c27241c3_1728982.jpeg" width = "200" height = "200" align=left/>
|
||||
#### 开源不易,劳烦各位star ☺
|
||||
|
||||
|
||||
|
||||
|
||||
6
doc/docs/guide/briefSupport.md
Normal file
@@ -0,0 +1,6 @@
|
||||
**如有问题,请提交 [Issue](https://gitee.com/anji-plus/report/issues) <br>**
|
||||
|
||||
**微信群: <br>**
|
||||

|
||||
|
||||
#### 开源不易,劳烦各位star ☺
|
||||
0
doc/docs/guide/briefUsing.md
Normal file
@@ -1,40 +1,7 @@
|
||||
## 快速部署
|
||||
下载地址:[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases)
|
||||
```js
|
||||
第一步,下载zip包,解压<br>
|
||||
第二步,conf->bootstrap-dev.yml,修改mysql连接<br>
|
||||
第三步,启动bin目录下start.sh<br>
|
||||
第四步,访问 http://localhost:9095/index.html
|
||||
```
|
||||
|
||||
## 编译打包
|
||||
在Linux上先准备好maven、node.js、jdk
|
||||
- [Apache Maven] 3.5 +<br>
|
||||
- [Node.js] v14.16.0+<br>
|
||||
- [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** 会出现兼容性问题,后续有解决方法将会在下方 **其他** 大类进行补充
|
||||
40
doc/docs/guide/quicklyDistribution.md
Normal file
@@ -0,0 +1,40 @@
|
||||
```
|
||||
第一步,下载zip包,解压<br>
|
||||
第二步,conf->bootstrap-dev.yml,修改mysql连接<br>
|
||||
第三步,启动bin目录下start.sh<br>
|
||||
第四步,访问 http://localhost:9095/index.html
|
||||
```
|
||||
|
||||
## 下载发行版
|
||||
下载地址:[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases)
|
||||

|
||||
|
||||
## 修改mysql连接
|
||||
解压下载好的Zip包,找到bootstrap-dev.yml <br>
|
||||
report-core-XXX --> conf --> bootstrap-dev.yml <br>
|
||||

|
||||
|
||||
将图中关于mysql的连接配置信息换成你使用的IP <br>
|
||||
**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错<br>
|
||||

|
||||
|
||||
## 修改路径
|
||||
使用上传功能,必须修改此内容
|
||||

|
||||
|
||||
## 启动
|
||||
linux启动:report-core-XXX --> bin --> start.sh <br>
|
||||
windows启动:report-core-XXX --> bin --> start.bat <br>
|
||||
**注**:beta.4版本的start.bat脚本有问题,会提示无法找到主类,请将脚本中的“-Xbootclasspath/a:%LIB_JARS% %JAVA_OPTS%”剪切放置后面<br>
|
||||

|
||||
如果仍然有问题,请换成start.sh启动
|
||||
**注**:脚本目前没有校验是否有Jdk、Mysql
|
||||
|
||||
|
||||
## 访问
|
||||
http://localhost:9095/index.html <br>
|
||||
默认密码:admin 123456
|
||||
|
||||
|
||||
|
||||
|
||||
0
doc/docs/guide/quicklySeparate.md
Normal file
43
doc/docs/guide/quicklySource.md
Normal file
@@ -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 +<br>
|
||||
- [Node.js] v14.16.0+<br>
|
||||
- [Jdk] 1.8 <br>
|
||||
**注**:已知**Jdk11**存在兼容性问题
|
||||
|
||||
## 克隆源码
|
||||
git clone https://gitee.com/anji-plus/report.git <br>
|
||||
|
||||
## build
|
||||
进入report目录,启动build.sh
|
||||

|
||||
编译完成后是放在当前目录下的build文件夹中:report-core-xxxx.zip <br>
|
||||
**注**:脚本目前没有校验是否有Jdk、Git、Node.js
|
||||
|
||||
## 解压,修改mysql连接
|
||||

|
||||
|
||||
## 修改路径
|
||||
使用上传功能,必须修改此内容
|
||||

|
||||
|
||||
## 启动
|
||||
report-core-XXX --> bin --> start.sh <br>
|
||||
sh bin/start.sh <br>
|
||||
**注**:脚本目前没有校验是否有Jdk、Mysql
|
||||
|
||||
## 访问
|
||||
http://serverip:9095 <br>
|
||||
默认密码:admin 123456
|
||||
|
Before Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 95 KiB |
BIN
doc/docs/picture/quickly/img.png
Normal file
|
After Width: | Height: | Size: 19 KiB |
BIN
doc/docs/picture/quickly/img_1.png
Normal file
|
After Width: | Height: | Size: 5.8 KiB |
BIN
doc/docs/picture/quickly/img_2.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
doc/docs/picture/quickly/img_3.png
Normal file
|
After Width: | Height: | Size: 7.6 KiB |
BIN
doc/docs/picture/quickly/img_4.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
doc/docs/picture/quickly/img_5.png
Normal file
|
After Width: | Height: | Size: 7.0 KiB |
BIN
doc/docs/picture/shipin.gif
Normal file
|
After Width: | Height: | Size: 1.5 MiB |
BIN
doc/docs/picture/weixin.jpeg
Normal file
|
After Width: | Height: | Size: 102 KiB |