diff --git a/README.md b/README.md index 28a8c888..c1b4ac5a 100644 --- a/README.md +++ b/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注释),双击启动 diff --git a/doc/docs/guide/quicklyDistribution.md b/doc/docs/guide/quicklyDistribution.md index bc4fd26d..81d3c2dd 100644 --- a/doc/docs/guide/quicklyDistribution.md +++ b/doc/docs/guide/quicklyDistribution.md @@ -6,42 +6,47 @@ ``` ## 下载发行版 -下载地址:[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases) - + +下载地址:[https://gitee.com/anji-plus/report/releases](https://gitee.com/anji-plus/report/releases) <br> + <br> ## 修改mysql连接 + 解压下载好的Zip包,找到bootstrap-dev.yml <br> report-core-XXX --> conf --> bootstrap-dev.yml <br> - + <br> 将图中关于mysql的连接配置信息换成你使用的IP <br> -**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错<br> +**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错 <br>  <br> -**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限 +**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限 <br> -## 修改路径 -使用上传功能,必须修改此内容 - +## 上传功能 + +使用上传功能,必须修改此内容 <br> + <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>  <br> **注**:如果你JAVA_HOME目录存在空格,将bat文件最下面的JAVA_HOME添加""号 - - + <br> ## 访问 + http://localhost:9095 <br> -默认密码:admin 123456 +默认密码:admin 123456 <br> ## 重置mysql连接 -登陆进来后请重置mysql连接 <br> + +登陆进来后请修改mysql数据源 <br> 数据源 --> mysql数据源 --> 编辑 --> 修改用户名密码 <br>  <br>  <br> diff --git a/doc/docs/guide/quicklySeparate.md b/doc/docs/guide/quicklySeparate.md index 63d16dd4..cd12fa79 100644 --- a/doc/docs/guide/quicklySeparate.md +++ b/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>  <br> **注**:不要下载发行版里面的 Source Code.zip <br> -## 修改mysql连接 +### 修改mysql连接 + report-core --> src --> main --> resources --> bootstrap.yml <br>  <br> 将图中关于mysql的连接配置信息换成你使用的IP <br> **注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错<br> **注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限 <br> -## 修改路径 +### 上传功能 + 使用上传功能,必须修改此内容 <br> - <br> + <br> + +### maven打包 -## maven打包 使用 maven package <br> **注**:不要使用maven install <br>  <br> -## linux启动jar包 +### linux启动jar包 + 将上步生成的jar包上传至linux,使用java -jar命令启动 <br> **注**:请确保你的linux有jdk <br> -# 本地启动前端 -## 前端编译 +## 本地启动前端 + +### 前端编译 + 进入前端目录:report-ui <br>  <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>  <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> diff --git a/doc/docs/guide/quicklySource.md b/doc/docs/guide/quicklySource.md index 4033fdfa..00b0c9ed 100644 --- a/doc/docs/guide/quicklySource.md +++ b/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,52 +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> - -**注**:不要下载发行版里面的 Source Code.zip + <br> +**注**:不要下载发行版里面的 Source Code.zip <br> ## build -进入report目录,启动build.sh + +进入report目录,启动build.sh <br>  <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>  <br> 将图中关于mysql的连接配置信息换成你使用的IP <br> -**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错<br> +**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错 <br>  <br> -**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限 +**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限 <br> -## 修改路径 -使用上传功能,必须修改此内容 +## 上传功能 + +使用上传功能,必须修改此内容 <br>  ## 启动 -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> + +看到控制台提示“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>  <br> - + <br>