modify readme&contributing

This commit is contained in:
zengqiao
2020-03-23 12:01:18 +08:00
parent 229140f067
commit fc87aaf0db
19 changed files with 72 additions and 894 deletions

View File

@@ -1,7 +1,7 @@
---
![kafka-manager-logo](./docs/assets/images/common/logo_name.png)
![kafka-manager-logo](doc/assets/images/common/logo_name.png)
**一站式`Apache Kafka`集群指标监控与运维管控平台**
@@ -32,18 +32,66 @@
## kafka-manager架构图
![kafka-manager-arch](./docs/assets/images/common/arch.png)
![kafka-manager-arch](doc/assets/images/common/arch.png)
---
## 安装手册
### 环境依赖
- `Maven 3.5.0+`(后端打包依赖)
- `node v8.12.0+`(前端打包依赖)
- `Java 8+`(运行环境需要)
- `MySQL`(数据存储)
---
### 环境初始化
执行[create_mysql_table.sql](doc/create_mysql_table.sql)中的SQL命令从而创建所需的MySQL库及表默认创建的库名是`kafka_manager`
```
############# 示例:
mysql -uXXXX -pXXX -h XXX.XXX.XXX.XXX -PXXXX < ./create_mysql_table.sql
```
---
### 打包
执行`mvn install`命令即可。
备注:每一次执行`mvn install`命令,都将在`web/src/main/resources/templates`下面生成最新的前端资源文件,如果`console`模块下的代码没有变更,可以修改`./pom.xml`文件,忽略对`console`模块的打包。
---
### 启动
```
############# application.yml 是配置文件
cp web/src/main/resources/application.yml web/target/
cd web/target/
nohup java -jar kafka-manager-web-1.0.0-SNAPSHOT.jar --spring.config.location=./application.yml > /dev/null 2>&1 &
```
### 使用
本地启动的话,访问`http://localhost:8080`,输入帐号及密码进行登录。更多参考:[kafka-manager使用手册](./user_cn_guide.md)
---
## 相关文档
- [kafka-manager安装手册](./docs/install_cn_guide.md)
- [kafka-manager使用手册](./docs/user_cn_guide.md)
- [kafka-manager使用手册](doc/user_cn_guide.md)
## 钉钉交流群
![dingding_group](./docs/assets/images/common/dingding_group.jpg)
![dingding_group](doc/assets/images/common/dingding_group.jpg)
## 项目成员