[CHORE] Update react app readme (#311)

This commit is contained in:
Oleg Shur 2021-03-25 12:42:40 +03:00 committed by GitHub
parent 8f4fc12f12
commit 9775f0dae7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,8 @@
# Kafka-UI
UI for Apache Kafka management
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=provectus_kafka-ui_frontend&metric=alert_status)](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
```
Set correct URL to your API server in `.env`.
```
REACT_APP_API_URL=http://api.your-kafka-rest-api.com:3004
```
Start application
```
npm start
Have to be run from root directory.
Start Kafka UI with your Kafka clusters:
```sh
docker-compose -f ./docker/kafka-ui.yaml up
```
Go to react app folder
```sh
cd ./kafka-ui-react-app
```
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