فهرست منبع

[CHORE] Update react app readme (#311)

Oleg Shur 4 سال پیش
والد
کامیت
9775f0dae7
1فایلهای تغییر یافته به همراه18 افزوده شده و 8 حذف شده
  1. 18 8
      kafka-ui-react-app/README.md

+ 18 - 8
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
+
+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