Update readme
This commit is contained in:
parent
fbc2ab306e
commit
ce749f480a
1 changed files with 12 additions and 11 deletions
|
@ -2,36 +2,37 @@
|
|||
UI for Apache Kafka management
|
||||
|
||||
## Table of contents
|
||||
- [Requirements](#requirements)
|
||||
- [Getting started](#getting-started)
|
||||
- [Links](#links)
|
||||
|
||||
## 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
|
||||
|
||||
Install packages
|
||||
|
||||
### 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.
|
||||
|
|
Loading…
Add table
Reference in a new issue