From ce88ddc4b5e874648b06014a47b826f37825a2df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=AE=B8=E6=99=93=E4=B8=9C?= <763795151@qq.com>
Date: Tue, 9 Nov 2021 17:08:57 +0800
Subject: [PATCH] polish README.md.
---
README.md | 32 ++++++++++++++++++++++++++++++--
assembly.xml | 1 +
package.bat | 1 +
3 files changed, 32 insertions(+), 2 deletions(-)
create mode 100644 package.bat
diff --git a/README.md b/README.md
index 5505e62..ad7f754 100644
--- a/README.md
+++ b/README.md
@@ -31,12 +31,17 @@
```
git clone https://github.com/xxd763795151/kafka-console-ui.git
cd kafka-console-ui
+# linux或mac执行
sh package.sh
+# windows执行
+./package.bat
```
-打包成功,输出文件:target/kafka-console-ui.tar.gz
+打包成功,输出文件(以下2种归档类型):
+* target/kafka-console-ui.tar.gz
+* target/kafka-console-ui.zip
## 部署
```
-# 解压缩
+# 解压缩(以tar.gz为例)
tar -zxvf kafka-console-ui.tar.gz
# 进入解压缩后的目录
cd kafka-console-ui
@@ -47,6 +52,29 @@ sh bin/start.sh
# 停止
sh bin/shutdown.sh
```
+启动完成,访问:http://127.0.0.1:7766
+## windows平台启动测试
+上面的操作步骤主要是针对类unix系统,如果是windows平台,有以下两种方式:
+### idea启动
+查看最下面的本地开发配置,本地开发环境配置完成,直接使用idea启动
+### 命令行启动
+如果觉得idea配置麻烦,只想启动一下测试看效果,可以通过命令行方式:
+
+1.先将代码clone或下载下来
+2.进入工程目录
+3.修改配置(如kafka集群地址),配置文件:`src/main/resources/application.yml`
+4.打包,打包命令如下
+```shell script
+# 执行打包脚本
+./package.bat
+# 或者执行下面这个命令打包(脚本里也是这一条命令)
+mvn clean scala:compile compile package -Dmaven.test.skip=true -Pdeploy
+```
+5.启动
+```shell script
+java -jar target/kafka-console-ui.jar
+```
+6.启动完成,访问:http://127.0.0.1:7766
# 开发环境
* jdk 8
* idea
diff --git a/assembly.xml b/assembly.xml
index 6363171..f82ffd1 100644
--- a/assembly.xml
+++ b/assembly.xml
@@ -5,6 +5,7 @@
rocketmq-reput
tar.gz
+ zip
diff --git a/package.bat b/package.bat
new file mode 100644
index 0000000..17d3f29
--- /dev/null
+++ b/package.bat
@@ -0,0 +1 @@
+mvn clean scala:compile compile package -Dmaven.test.skip=true -Pdeploy