efb8410bd6
* closes 1602 * readme * fixes * docs Co-authored-by: Roman Zabaluev <rzabaluev@provectus.com>
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
# UI for Apache Kafka
|
|
UI for Apache Kafka management
|
|
|
|
[](https://sonarcloud.io/dashboard?id=provectus_kafka-ui_frontend)
|
|
|
|
## Table of contents
|
|
- [Requirements](#requirements)
|
|
- [Getting started](#getting-started)
|
|
- [Links](#links)
|
|
|
|
## Requirements
|
|
- [docker](https://www.docker.com/get-started) (required to run [Initialize application](#initialize-application))
|
|
- [nvm](https://github.com/nvm-sh/nvm) with installed [Node.js](https://nodejs.org/en/) of expected version (check `.nvmrc`)
|
|
|
|
## Getting started
|
|
|
|
Go to react app folder
|
|
```sh
|
|
cd ./kafka-ui-react-app
|
|
```
|
|
|
|
Install Husky
|
|
```
|
|
npm install -g husky
|
|
```
|
|
|
|
Install dependencies
|
|
```
|
|
npm install
|
|
```
|
|
|
|
Generate API clients from OpenAPI document
|
|
```sh
|
|
npm run gen:sources
|
|
```
|
|
|
|
## Start application
|
|
### Proxying API Requests in Development
|
|
|
|
Create or update existing `.env.local` file with
|
|
```
|
|
HTTPS=true # if needed
|
|
DEV_PROXY= https://api.server # your API server
|
|
```
|
|
|
|
Run the application
|
|
```sh
|
|
npm start
|
|
```
|
|
|
|
### Docker way
|
|
|
|
Have to be run from root directory.
|
|
|
|
Start UI for Apache Kafka with your Kafka clusters:
|
|
```sh
|
|
docker-compose -f ./documentation/compose/kafka-ui.yaml up
|
|
```
|
|
|
|
Make sure that none of the `.env*` files contain `DEV_PROXY` variable
|
|
|
|
Run the application
|
|
```sh
|
|
npm start
|
|
```
|
|
## Links
|
|
|
|
* [Bulma](https://bulma.io/documentation/) - free, open source CSS framework based on Flexbox
|
|
* [Create React App](https://github.com/facebook/create-react-app)
|