Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 3.7 KB

README.md

File metadata and controls

105 lines (65 loc) · 3.7 KB
Raw

Kafka Cluster Management UI Tool

中文 | English

About

Kafka Sprout is a web GUI that helps you quickly start up Zookeeper and Kafka servers on your local machine without any code configuration. Easily view, manage, and configure your Kafka topics and brokers with a push of a button. Kafka Sprout also displays relevant realtime metrics including Request Rate, Network I/O Rate, etc. Give it a spin and let us know what features you want next!


👋 Goodbye Clunky Terminal Windows, Hello Web GUI

Start Cluster

Configure and Start Brokers

View, Add, and Delete Topics

Features

🚀 Push to Start Zookeeper and Kafka Server

➕ Quickly Add and Delete Topics

💪 Setup Kafka Brokers with Ease

🚦 Monitor Key Performance Metrics

🔎 Explore Topic and Broker Configurations


Getting Started

Installation

  1. Clone this repo:
git clone https://github.com/oslabs-beta/Kafka-Sprout.git
  1. Run the application in the root folder. This will also install node locally to build the frontend.
mvn spring-boot:run # for Mac
./mvnw spring-boot:run # for Windows
  1. Go to http://localhost:8080/ on your browser.

Set Up

Requirements

  • Java (version 11 or newer)
  • Maven (version 3.6.3 or newer)
  • Kafka (version 0.11.0 or newer)
  • Node.js (version 12.18.3 or newer)

Built With

Spring Boot | Spring Web Socket | Styled Components | React | Typescript | Apache Kafka

Contributors

Brian Hong | Midori Yang | Nak Kim | Nicole Ip | Winford Lin

Contributions Welcome!

If you found this interesting or helpful at all, feel free to drop a ⭐ GitHub stars ⭐ on this project to show your support!

You can contribute by:

  • Raising any issues you find using Kafka Sprout
  • Fixing issues by opening Pull Requests
  • Improving documentation

All bugs, tasks or enhancements are tracked as GitHub issues. Issues which might be a good start for new contributors are marked with "good-start" label.

If you want to get in touch with us first before contributing, shoot us an email at [email protected]. Kafka Sprout is actively maintained!

License

MIT