From 9775f0dae7b4c9259ce4e8936f3dc72ad332399f Mon Sep 17 00:00:00 2001
From: Oleg Shur <workshur@gmail.com>
Date: Thu, 25 Mar 2021 12:42:40 +0300
Subject: [PATCH] [CHORE] Update react app readme (#311)

---
 kafka-ui-react-app/README.md | 34 ++++++++++++++++++++++------------
 1 file changed, 22 insertions(+), 12 deletions(-)

diff --git a/kafka-ui-react-app/README.md b/kafka-ui-react-app/README.md
index a2211a9929..ba16ab5eb6 100644
--- a/kafka-ui-react-app/README.md
+++ b/kafka-ui-react-app/README.md
@@ -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