readme polish

This commit is contained in:
许晓东
2021-11-13 23:35:13 +08:00
parent 0f493b0751
commit 8ca75e301b

View File

@@ -40,6 +40,7 @@ package.bat
* target/kafka-console-ui.tar.gz
* target/kafka-console-ui.zip
## 部署
### Mac OS 或 Linux
```
# 解压缩(以tar.gz为例)
tar -zxvf kafka-console-ui.tar.gz
@@ -52,24 +53,13 @@ sh bin/start.sh
# 停止
sh bin/shutdown.sh
```
### Windows
1.解压缩zip安装包
2.编辑配置文件 `config/application.yml`
3.进入bin目录必须在bin目录下执行`start.bat`启动
启动完成访问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
@@ -79,7 +69,7 @@ java -jar target/kafka-console-ui.jar
* jdk 8
* idea
* scala 2.13
* maven 3+
* maven >=3.6+
* webstorm
除了webstorm是开发前端的ide可以根据自己需要代替jdk scala是必须有的。
# 本地开发配置