Browse Source

Merge pull request #153 from provectus/update-kafka-ui-react-app-readme

Updated readme for react app
Oleg Shur 4 năm trước cách đây
mục cha
commit
4d8ef5e61f
1 tập tin đã thay đổi với 12 bổ sung11 xóa
  1. 12 11
      kafka-ui-react-app/README.md

+ 12 - 11
kafka-ui-react-app/README.md

@@ -2,36 +2,37 @@
 UI for Apache Kafka management
 
 ## Table of contents
+- [Requirements](#requirements)
 - [Getting started](#getting-started)
 - [Links](#links)
 
-## Getting started
-
-Install packages
+## 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
+### Initialize application
+Have to be run from root directory
 ```
-npm install
+./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
 ```
-
+If you plan to use full fake REST API you have to update `.env`.
+```
+REACT_APP_API_URL=http://localhost:3004
+```
 Start JSON Server if you prefer to use default full fake REST API.
-
 ```
 npm run mock
 ```
-
 Start application
-
 ```
 npm start
 ```
 
-
 ## Links
 
 * [JSON Server](https://github.com/typicode/json-server) - Fake REST API.