diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6a59fd --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# KafkaDesktop + +> 一款轻量级 kafka 桌面端管理工具 + +## 技术栈 +- 项目脚手架 Electron + Vite + React + TypeScript: https://github.com/electron-vite/electron-vite-react +- 组件库 React Suite: https://github.com/rsuite/rsuite/tree/main +- Kafka 客户端库 KafkaJs: https://github.com/tulios/kafkajs +- 配置文件存储 electron-store: https://github.com/sindresorhus/electron-store +- 跨组件通信 PubSubJS: https://github.com/mroderick/PubSubJS + +## 支持功能 +- 支持 Kafka 集群多连接管理 +- 集群节点信息查看 +- Topic 管理:新增、删除、模糊查询和 topic 分区信息查看 +- 查询消息:从头消费、实时消费、单次拉取消费、指定 offset 消费、指定分区消费 +- 消费到消息支持 json 消息自动格式化查看 +- 消息发送:支持指定消息 key +- 主题切换:亮色 / 暗色主题切换 +- 全局字体使用:[HarmonyOS Sans 字体](https://developer.harmonyos.com/cn/design/resource) + +## 下载体验 +进入 release 页面,下载最新版本的安装包即可: https://github.com/hczs/kafka-desktop/releases + +## 工具截图 +### 亮色主题 +![亮色主题](./attchments/20231029120246.png) +### 暗色主题 +![暗色主题](./attchments/20231029120303.png) +### 添加连接 +![添加连接](./attchments/20231029120018.png) +### 集群连接管理 +![集群连接管理](./attchments/20231029120342.png) +### 集群信息查看 +![集群信息查看](./attchments/20231029120423.png) +### Topic 管理 +![Topic 管理](./attchments/20231029120443.png) +### Topic 分区信息查看 +![Topic 分区信息查看](./attchments/20231029120527.png) +### 消息拉取 +![消息拉取](./attchments/20231029120559.png) +### 消息查看 +![消息查看](./attchments/20231029120705.png) +### 消息发送 +![消息发送](./attchments/20231029120735.png) + +## 开发步骤 +项目开发环境 node 版本:v18.12.1 +```bash +# 克隆项目 +git clone https://github.com/hczs/kafka-desktop + +# 进入项目文件夹 +cd kafka-desktop + +# 安装依赖 +npm install + +# 运行项目 +npm run dev +``` \ No newline at end of file diff --git a/attchments/20231029120018.png b/attchments/20231029120018.png new file mode 100644 index 0000000..071a4f4 Binary files /dev/null and b/attchments/20231029120018.png differ diff --git a/attchments/20231029120246.png b/attchments/20231029120246.png new file mode 100644 index 0000000..0a7aa24 Binary files /dev/null and b/attchments/20231029120246.png differ diff --git a/attchments/20231029120303.png b/attchments/20231029120303.png new file mode 100644 index 0000000..269c589 Binary files /dev/null and b/attchments/20231029120303.png differ diff --git a/attchments/20231029120342.png b/attchments/20231029120342.png new file mode 100644 index 0000000..b7614d0 Binary files /dev/null and b/attchments/20231029120342.png differ diff --git a/attchments/20231029120423.png b/attchments/20231029120423.png new file mode 100644 index 0000000..2b6f5ff Binary files /dev/null and b/attchments/20231029120423.png differ diff --git a/attchments/20231029120443.png b/attchments/20231029120443.png new file mode 100644 index 0000000..b047cd7 Binary files /dev/null and b/attchments/20231029120443.png differ diff --git a/attchments/20231029120527.png b/attchments/20231029120527.png new file mode 100644 index 0000000..3085dd9 Binary files /dev/null and b/attchments/20231029120527.png differ diff --git a/attchments/20231029120559.png b/attchments/20231029120559.png new file mode 100644 index 0000000..19483f5 Binary files /dev/null and b/attchments/20231029120559.png differ diff --git a/attchments/20231029120705.png b/attchments/20231029120705.png new file mode 100644 index 0000000..b011417 Binary files /dev/null and b/attchments/20231029120705.png differ diff --git a/attchments/20231029120735.png b/attchments/20231029120735.png new file mode 100644 index 0000000..02addb2 Binary files /dev/null and b/attchments/20231029120735.png differ