Kafbat UI

Web UI for managing Apache Kafka clusters

Table of contents

• Requirements
• Getting started
• Links

Requirements

• docker (required to run Initialize application)
• nvm with installed Node.js of expected version (check .nvmrc)

Getting started

Go to react app folder

cd ./frontend

Install pnpm

npm install -g pnpm

Update pnpm

npm rm -g pnpm

Then reinstall it

or use

npm install -g pnpm@<version>

Install dependencies

pnpm install

Generate API clients from OpenAPI document

pnpm gen:sources

Start application

Proxying API Requests in Development

Create or update existing .env.local file with

VITE_DEV_PROXY= https://api.server # your API server

Run the application

pnpm dev

Docker way

Have to be run from root directory.

Start Kafbat UI with your Kafka clusters:

docker-compose -f ./documentation/compose/kafbat-ui.yaml up

Make sure that none of the .env* files contain DEV_PROXY variable

Run the application

pnpm dev

Links

• Vite