|
|
@@ -1,31 +1,38 @@
|
|
|
-# kafka-ui
|
|
|
+# Kafka-UI
|
|
|
UI for Apache Kafka management
|
|
|
|
|
|
-## Frontend
|
|
|
+## Table of contents
|
|
|
+- [Getting started](#getting-started)
|
|
|
+- [Links](#links)
|
|
|
|
|
|
-### Env variables
|
|
|
-Pls update `./frontend/.env` file
|
|
|
+## Getting started
|
|
|
+
|
|
|
+Install packages
|
|
|
+
|
|
|
+```
|
|
|
+npm install
|
|
|
+```
|
|
|
+
|
|
|
+Set correct URL to your API server in `.env`.
|
|
|
|
|
|
```
|
|
|
# API url
|
|
|
-REACT_APP_API_URL=http://localhost:3004
|
|
|
+REACT_APP_API_URL=http://api.your-kafka-rest-api.com:3004
|
|
|
```
|
|
|
|
|
|
-### Start App
|
|
|
+Start JSON Server if you prefer to use default full fake REST API.
|
|
|
|
|
|
```
|
|
|
-cd ./frontend
|
|
|
-npm install
|
|
|
+npm run mock
|
|
|
+```
|
|
|
+
|
|
|
+Start application
|
|
|
|
|
|
+```
|
|
|
npm start
|
|
|
```
|
|
|
|
|
|
|
|
|
-## API
|
|
|
+## Links
|
|
|
|
|
|
-```
|
|
|
-cd ./frontend
|
|
|
-npm install
|
|
|
-
|
|
|
-npm run dev
|
|
|
-```
|
|
|
+* [JSON Server] - Fake REST API(https://github.com/typicode/json-server)
|
Oleg Shuralev