Skip to content

Commit 4d8ef5e

Browse files
authored
Merge pull request #153 from provectus/update-kafka-ui-react-app-readme
Updated readme for react app
2 parents fbc2ab3 + ce749f4 commit 4d8ef5e

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

kafka-ui-react-app/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,37 @@
22
UI for Apache Kafka management
33

44
## Table of contents
5+
- [Requirements](#requirements)
56
- [Getting started](#getting-started)
67
- [Links](#links)
78

8-
## Getting started
9-
10-
Install packages
9+
## Requirements
10+
- [docker](https://www.docker.com/get-started) (required to run [Initialize application](#initialize-application))
11+
- [nvm](https://github.com/nvm-sh/nvm) with installed [Node.js](https://nodejs.org/en/) of expected version (check `.nvmrc`)
1112

13+
## Getting started
14+
### Initialize application
15+
Have to be run from root directory
1216
```
13-
npm install
17+
./mvnw clean install -Pprod
1418
```
15-
1619
Set correct URL to your API server in `.env`.
17-
1820
```
1921
REACT_APP_API_URL=http://api.your-kafka-rest-api.com:3004
2022
```
21-
23+
If you plan to use full fake REST API you have to update `.env`.
24+
```
25+
REACT_APP_API_URL=http://localhost:3004
26+
```
2227
Start JSON Server if you prefer to use default full fake REST API.
23-
2428
```
2529
npm run mock
2630
```
27-
2831
Start application
29-
3032
```
3133
npm start
3234
```
3335

34-
3536
## Links
3637

3738
* [JSON Server](https://github.com/typicode/json-server) - Fake REST API.

0 commit comments

Comments
 (0)