!20 更新文档和README

Merge pull request !20 from Foming/dev

README.md

@@ -99,11 +99,11 @@
 git clone https://gitee.com/anji-plus/report.git
 cd report
 sh build.sh
-编译完成放在build文件夹 report-core-xxxx.zip
+编译完成放在build文件夹 aj-report-xxxx.zip
 
-unzip report-core-xxxx.zip
-cd report-core-xxxx
-vim conf/bootstrap-dev.yml 数据库连接
+unzip aj-report-xxxx.zip
+cd aj-report-xxxx
+vim conf/bootstrap-dev.yml 修改数据库连接等信息
 sh bin/start.sh Linux启动
 bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释)，双击启动
 
@@ -111,9 +111,12 @@ bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释)，双击启
 http://serverip:9095
 ```
 
-源码编译部署参考文档：https://report.anji-plus.com/report-doc/guide/quicklySource.html <br>
-发行版部署参考文档：https://report.anji-plus.com/report-doc/guide/quicklyDistribution.html <br>
-前后端分离部署参考文档：https://report.anji-plus.com/report-doc/guide/quicklySeparate.html <br>
+**源码编译部署参考文档：** <br>
+https://report.anji-plus.com/report-doc/guide/quicklySource.html <br>
+**发行版部署参考文档：** <br>
+https://report.anji-plus.com/report-doc/guide/quicklyDistribution.html <br>
+**前后端分离部署参考文档：** <br>
+https://report.anji-plus.com/report-doc/guide/quicklySeparate.html <br>
 
 ## 操作手册
 
@@ -135,24 +138,29 @@ sql文件的目录在：report-core --> src --> main --> resources -- > db.migra
 <a href='https://www.yunstech.cn/'><img src="https://www.yunstech.cn/images/logo.png" width = "130" height = "50" /> </a>
 <a href='http://www.fgkb.net/'><img src="https://report.anji-plus.com/file/download/9ee5b709-5033-4cd5-a784-ebd2877fd373" width = "130" height = "50" /> </a>
 <a href='https://www.gykjweb.com/'><img src="https://report.anji-plus.com/file/download/d13b03f5-0c20-4878-9a79-f3c76b44bfd9" width = "130" height = "130" /> </a>
+<a href='http://www.turingoal.com/'><img src="https://report.anji-plus.com/file/download/cda7bf68-376b-45dc-9a55-c52b21e4a8c8" width = "130" height = "50" /> </a>
 
-## 近期计划
+## 未来计划
 
-- 完善地图插件
-- 完善表格插件
-- 丰富自定义框图、挂件
-- 丰富更多图表组件
-- 基础图表增加
-- 现有图表功能修复/增加
+- 增加装饰图、省市区地图等图
+- 表格数据解析方式优化
+- 增加基础边框样式
+- http数据源调整
+- 大屏工具栏使用二级菜单显示
+- Execl报表功能增加与bug修复
+
+## 已知问题
+
+- 大屏宽高动态适配问题
 
 ## 版本问题
 
 已知以下版本存在兼容性问题
 
 - Node.js V16
+- openJdk
 - Jdk 11
 - Mysql 8.0（8.0.23/26版本没有问题，8.0.21版本存在问题）
-- Windows 11
 
 AJ-Report 使用Druid，版本为1.2.6，如果你觉得你配置都是正常但是数据源测试不过，请尝试修改pom文件降低Druid版本。 <br>
 例如：MSSQLSERVER 2014，请将Druid版本降低为1.2.1以下（需要修改源码）。 <br>

doc/docs/guide/quicklyDistribution.md

@@ -6,42 +6,47 @@
 ```
 
 ## 下载发行版
-下载地址：[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases)
-![img.png](../picture/quickly/img.png)
+
+下载地址：[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases) <br>
+![img.png](../picture/quickly/img.png) <br>
 
 ## 修改mysql连接
+
 解压下载好的Zip包，找到bootstrap-dev.yml <br>
 report-core-XXX --> conf --> bootstrap-dev.yml <br>
-![img_1.png](../picture/quickly/img_1.png)
+![img_1.png](../picture/quickly/img_1.png) <br>
 
 将图中关于mysql的连接配置信息换成你使用的IP <br>
-**注**：aj_report库是存放底层基础信息的库，flyway启动时会自动建立，如果你在这里修改了库，将会出错<br>
+**注**：aj_report库是存放底层基础信息的库，flyway启动时会自动建立，如果你在这里修改了库，将会出错 <br>
 
 ![bootstrap.png](../picture/quickly/img_2.png) <br>
-**注**：请确认你的Mysql是否支持远程连接，登陆用户是否有DDL权限
+**注**：请确认你的Mysql是否支持远程连接，登陆用户是否有DDL权限 <br>
 
-## 修改路径
-使用上传功能，必须修改此内容
-![file.png](../picture/quickly/img_5.png)
+## 上传功能
+
+使用上传功能，必须修改此内容 <br>
+![file.png](../picture/quickly/img_5.png) <br>
 
 ## 启动
+
 linux启动：<br>
-report-core-XXX --> bin -->sh start.sh <br>
+aj-report-XXX --> bin -->sh start.sh <br>
 
 windows启动：<br>
-report-core-XXX --> bin --> start.bat <br>
+aj-report-XXX --> bin --> start.bat <br>
 修改第4行的JAVA_HOME，改成你自己的JAVA_HOME，并去掉**rem**注释，双击启动<br>
 ![java.png](../picture/quickly/img_7.png) <br>
 **注**：如果你JAVA_HOME目录存在空格，将bat文件最下面的JAVA_HOME添加""号
-![img.png](../picture/quickly/img_8.png)
-
+![img.png](../picture/quickly/img_8.png) <br>
 
 ## 访问
+
 http://localhost:9095 <br>
-默认密码：admin 123456
+默认密码：admin 123456 <br>
 
 ## 重置mysql连接
-登陆进来后请重置mysql连接 <br>
+
+登陆进来后请修改mysql数据源 <br>
 数据源 --> mysql数据源 --> 编辑 --> 修改用户名密码 <br>
 ![img](../picture/quickly/img_14.png) <br>
 ![img_6.png](../picture/quickly/img_6.png) <br>

doc/docs/guide/quicklySeparate.md

@@ -1,5 +1,6 @@
 **前后端分离：请对自己有动手能力的小伙伴进行尝试**
 **请根据自己的实际情况对下面的步骤和内容进行调整**
+
 ```
 linux：
 git clone https://gitee.com/anji-plus/report.git
@@ -14,64 +15,80 @@ BASE_API: '"./"'，改成自己后端的api
 npm install
 npm run build
 ```
-# linux部署后端
-## 编译环境
+
+## linux部署后端
+
+### 编译环境
+
 - [Apache Maven] 3.5 +<br>
 - [Node.js] v14.16.0+<br>
 - [Jdk] 1.8 <br>
-请在你的Windows上先准备好maven、node.js、jdk <br>
-**注**：已知**Jdk11**存在兼容性问题 <br>
+  请在你的Windows上先准备好maven、node.js、jdk <br>
+  **注**：已知**Jdk11**存在兼容性问题，请不要使用openJdk，环境问题请看**常见问题**大类 <br>
+
+### 克隆源码
 
-## 克隆源码
 git clone https://gitee.com/anji-plus/report.git <br>
 ![img9.png](../picture/quickly/img_9.png) <br>
 **注**：不要下载发行版里面的 Source Code.zip <br>
 
-## 修改mysql连接
+### 修改mysql连接
+
 report-core --> src --> main --> resources --> bootstrap.yml <br>
 ![bootstrap.png](../picture/quickly/img_2.png) <br>
 将图中关于mysql的连接配置信息换成你使用的IP <br>
 **注**：aj_report库是存放底层基础信息的库，flyway启动时会自动建立，如果你在这里修改了库，将会出错<br>
 **注**：请确认你的Mysql是否支持远程连接，登陆用户是否有DDL权限 <br>
 
-## 修改路径
-使用上传功能，必须修改此内容 <br>
-![file.png](../picture/quickly/img_5.png) <br> 
+### 上传功能
+
+使用上传功能，必须修改此内容 <br>
+![file.png](../picture/quickly/img_5.png) <br>
+
+### maven打包
 
-## maven打包
 使用 maven package <br>
 **注**：不要使用maven install <br>
 ![img10](../picture/quickly/img_10.png) <br>
 
-## linux启动jar包
+### linux启动jar包
+
 将上步生成的jar包上传至linux，使用java -jar命令启动 <br>
 **注**：请确保你的linux有jdk <br>
 
-# 本地启动前端
-## 前端编译
+## 本地启动前端
+
+### 前端编译
+
 进入前端目录：report-ui <br>
 ![img11](../picture/quickly/img_11.png) <br>
 执行 npm install <br>
 
-## 修改config
+### 修改config
+
 目录地址：report-ui --> config --> dev.env.js <br>
 修改你的BASE_API地址 <br>
 
-## 启动前端
+### 启动前端
+
 report-ui目录： <br>
 执行 npm run dev <br>
 
-# 前端build
-## 前端编译
-进入前端目录：report-ui <br> 
+## 前端build
+
+### 前端编译
+
+进入前端目录：report-ui <br>
 ![img11](../picture/quickly/img_11.png) <br>
 执行 npm install <br>
 
-## 修改config
+### 修改config
+
 目录地址：report-ui --> config --> prod.env.js <br>
 修改你的BASE_API地址 <br>
 
-## build
+### build
+
 reoprt-ui目录： <br>
 执行 npm run build <br>
 

doc/docs/guide/quicklySource.md

@@ -2,11 +2,11 @@
 git clone https://gitee.com/anji-plus/report.git
 cd report
 sh build.sh
-编译完成放在build文件夹 report-core-xxxx.zip
+编译完成放在build文件夹 aj-report-xxxx.zip
 
-unzip report-core-xxxx.zip
-cd report-core-xxxx
-vim conf/bootstrap-dev.yml 数据库连接、上传文件的路径以及地址修改
+unzip aj-report-xxxx.zip
+cd aj-report-xxxx
+vim conf/bootstrap-dev.yml 修改数据库连接、上传文件的路径以及地址
 sh bin/start.sh
 
 访问
@@ -14,48 +14,61 @@ http://serverip:9095
 ```
 
 ## 编译环境
+
 请在Linux上先准备好maven、node.js、jdk
-- [Apache Maven] 3.5 +<br>
-- [Node.js] v14.16.0+<br>
+
+- [Apache Maven] 3.5 + <br>
+- [Node.js] v14.16.0 + <br>
 - [Jdk] 1.8 <br>
-**注**：已知**Jdk11**存在兼容性问题
-  
+  **注**：已知**Jdk11**存在兼容性问题，请不要使用openJdk，环境问题请看**常见问题**大类 <br>
+
 ## 克隆源码
+
 git clone https://gitee.com/anji-plus/report.git <br>
-![img9.png](../picture/quickly/img_9.png)
-**注**：不要下载发行版里面的 Source Code.zip
+![img9.png](../picture/quickly/img_9.png) <br>
+**注**：不要下载发行版里面的 Source Code.zip <br>
 
 ## build
-进入report目录，启动build.sh
+
+进入report目录，启动build.sh <br>
 ![img_4.png](../picture/quickly/img_4.png) <br>
-编译完成后是放在当前目录下的build文件夹中：report-core-xxxx.zip <br>
+编译完成后是放在当前目录下的build文件夹中：aj-report-xxxx.zip <br>
 
 ## 修改mysql连接
-解压report-core-xxxx.zip，找到bootstrap-dev.yml
 
+解压aj-report-xxxx.zip，找到bootstrap-dev.yml <br>
 ![img_1.png](../picture/quickly/img_1.png) <br>
 
 将图中关于mysql的连接配置信息换成你使用的IP <br>
-**注**：aj_report库是存放底层基础信息的库，flyway启动时会自动建立，如果你在这里修改了库，将会出错<br>
+**注**：aj_report库是存放底层基础信息的库，flyway启动时会自动建立，如果你在这里修改了库，将会出错 <br>
 
 ![bootstrap.png](../picture/quickly/img_2.png) <br>
-**注**：请确认你的Mysql是否支持远程连接，登陆用户是否有DDL权限
+**注**：请确认你的Mysql是否支持远程连接，登陆用户是否有DDL权限 <br>
 
-## 修改路径
-使用上传功能，必须修改此内容
+## 上传功能
+
+使用上传功能，必须修改此内容 <br>
 ![file.png](../picture/quickly/img_5.png)
 
 ## 启动
-report-core-XXX --> bin --> start.sh <br>
+
+aj-report-XXX --> bin --> start.sh <br>
 sh bin/start.sh <br>
 
+## 日志位置
+
+看到控制台提示“The AJ-Report started!”，说明report正在启动，可以看看日志以确定程序启动到哪里了。<br>
+日志的位置是：report-xxx/logs/aj-report.log <br>
+
 ## 访问
+
 http://serverip:9095 <br>
-默认密码：admin 123456
+默认密码：admin 123456 <br>
 
 ## 重置mysql连接
-登陆进来后请重置mysql连接 <br>
+
+登陆进来后请修改mysql数据源 <br>
 数据源 --> mysql数据源 --> 编辑 --> 修改用户名密码 <br>
 ![img](../picture/quickly/img_14.png) <br>
-![img_6.png](../picture/quickly/img_6.png)
+![img_6.png](../picture/quickly/img_6.png) <br>