Skip to content
This repository was archived by the owner on Mar 12, 2025. It is now read-only.

Commit 7d9f6be

Browse files
Update README
1 parent 2ebb869 commit 7d9f6be

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,30 @@
22

33

44
## Dependencies
5+
56
- nodejs https://nodejs.org/en/ (v8+)
67

78

9+
810
## Configuration
911
Configuration for the notification server is at `config/default.js`.
1012
The following parameters can be set in config files or in env variables:
13+
1114
- LOG_LEVEL: the log level
1215
- PORT: the server port
1316
- KAFKA_OPTIONS: Kafka consumer options, see https://www.npmjs.com/package/no-kafka for available options
1417

1518
For the Kafka connection options:
19+
1620
- connectionString is comma delimited list of initial brokers list
1721
- secure connection may be achieved via ssl field, see https://www.npmjs.com/package/no-kafka#ssl for details
1822

19-
2023
## Local Kafka setup
2124

2225
- `http://kafka.apache.org/quickstart` contains details to setup and manage Kafka server,
2326
below provides details to setup Kafka server in Mac, Windows will use bat commands in bin/windows instead
2427
- download kafka at `https://www.apache.org/dyn/closer.cgi?path=/kafka/1.1.0/kafka_2.11-1.1.0.tgz`
25-
- extract out the doanlowded tgz file
28+
- extract out the downloaded tgz file
2629
- go to extracted directory kafka_2.11-0.11.0.1
2730
- start ZooKeeper server:
2831
`bin/zookeeper-server-start.sh config/zookeeper.properties`
@@ -43,7 +46,6 @@ For the Kafka connection options:
4346
- use another terminal, go to same directory, start a consumer to view the messages:
4447
`bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic challenge.notification.create --from-beginning`
4548

46-
4749
## Front end UI setup
4850

4951
- the front end UI's build folder content are exposed as public content by the app, so you may directly access it
@@ -52,16 +54,16 @@ For the Kafka connection options:
5254
run `npm install`, `npm start`, then access `http://localhost:3000`
5355
- note that if the front end UI's config is changed, it must be re-built using `npm run build` in the ui folder
5456

55-
5657
## Local deployment
58+
5759
- setup Kafka as above
5860
- install dependencies `npm i`
5961
- run code lint check `npm run lint`
6062
- run test `npm run test`
6163
- start app `npm start`, the app is running at `http://localhost:4000`
6264

63-
6465
## Heroku Deployment
66+
6567
- git init
6668
- git add .
6769
- git commit -m message
@@ -70,8 +72,6 @@ For the Kafka connection options:
7072
- heroku config:set KAFKA_PRODUCER_URL=some-public-kafka-url
7173
- git push heroku master
7274

73-
74-
7575
## Verification
7676

7777
- setup stuff following above deployment
@@ -81,4 +81,3 @@ For the Kafka connection options:
8181
- filter the messages and see results
8282
- use the UI to post message to Kafka, see above for example message, the data stream table should also show the posted message
8383
- you may also use the above kafka-console-consumer to view the Kafka messages
84-

0 commit comments

Comments
 (0)