|
@@ -1,6 +1,8 @@
|
|
|
# Kafka-UI
|
|
|
UI for Apache Kafka management
|
|
|
|
|
|
+[](https://sonarcloud.io/dashboard?id=provectus_kafka-ui_frontend)
|
|
|
+
|
|
|
## Table of contents
|
|
|
- [Requirements](#requirements)
|
|
|
- [Getting started](#getting-started)
|
|
@@ -11,20 +13,28 @@ UI for Apache Kafka management
|
|
|
- [nvm](https://github.com/nvm-sh/nvm) with installed [Node.js](https://nodejs.org/en/) of expected version (check `.nvmrc`)
|
|
|
|
|
|
## Getting started
|
|
|
-### Initialize application
|
|
|
-Have to be run from root directory
|
|
|
-```
|
|
|
-./mvnw clean install -Pprod
|
|
|
+
|
|
|
+Have to be run from root directory.
|
|
|
+
|
|
|
+Start Kafka UI with your Kafka clusters:
|
|
|
+```sh
|
|
|
+docker-compose -f ./docker/kafka-ui.yaml up
|
|
|
```
|
|
|
-Set correct URL to your API server in `.env`.
|
|
|
+
|
|
|
+Go to react app folder
|
|
|
+```sh
|
|
|
+cd ./kafka-ui-react-app
|
|
|
```
|
|
|
-REACT_APP_API_URL=http://api.your-kafka-rest-api.com:3004
|
|
|
+
|
|
|
+Generate API clients from OpenAPI document
|
|
|
+```sh
|
|
|
+npm run gen:sources
|
|
|
```
|
|
|
+
|
|
|
Start application
|
|
|
-```
|
|
|
+```sh
|
|
|
npm start
|
|
|
```
|
|
|
-
|
|
|
## Links
|
|
|
|
|
|
* [Bulma](https://bulma.io/documentation/) - free, open source CSS framework based on Flexbox
|