kafka-pub-sub 👋

kafka-pub-sub is designed based on KafkaJS with the support of stream processing that enables applications to publish, consume and process high volumes of record streams in a fast and durable way.

🔖 Table Of Contents

• 🌱 Prerequisites
• ⏬ Installing
• 👨‍💻 Example
• 👌 Test
• 💡 How To Contribute
• 📈 Project Activity
• 👤 Author
• 🔏 License

---

🌱 Prerequisites

• NPM/Yarn LTS
• NodeJs

Back To The Top

---

⏬ Installing

💻 Desktop

If you use Linux, try run commands bellow as sudo

1npm i kafka-pub-sub

or

1yarn add kafka-pub-sub

Back To The Top

---

👨‍💻 Example

Project stucture

Note: Create NodeJS environment in both service-1 and service-2 and create server using your favourite NodeJS framewwork.

service-1/server.js

1const ProduceEvent = require('kafka-pub-sub/ProduceEvent');
2
3app.post('/api', async (req, res) => {
4    const fakeData = {
5        Name: "Md. Muhtasim Fuad Fahim",
6        Email: "mdmuhtasim.fahim@gmail.com",
7    };
8
9    const headers = { 
10        'correlation-id': `1-${Date.now()}`,
11        'system-id': 'my-system-id'
12    };
13    const producedEvent = await ProduceEvent('TEST_TOPIC', 'TEST_EVENT', fakeData, headers)
14    console.log(producedEvent)
15
16    return res.status(200).send("Done!");
17});

service-2/server.js

1const ConsumeEvent = require('kafka-pub-sub/ConsumeEvent');
2
3(async function consumedEvent() {
4    const consumedData = await ConsumeEvent('TEST_TOPIC')
5    console.log(consumedData);
6})();

service-1/.env & service-2/.env

1KAFKA_CLIENT_ID=test-client
2KAFKA_BROKER_URL=localhost:9092
3KAFKA_GROUP_ID=test-group

sample docker-compose.yml

1version: '2.1'
2services:
3  zookeeper:
4    hostname: zookeeper
5    container_name: zookeeper
6    image: confluentinc/cp-zookeeper:latest
7    environment:
8      ZOOKEEPER_CLIENT_PORT: 2181
9      ZOOKEEPER_TICK_TIME: 2000
10  kafka:
11    hostname: kafka
12    container_name: kafka
13    image: confluentinc/cp-kafka:latest
14    depends_on:
15      - zookeeper
16    ports:
17      - 9092:9092
18    environment:
19      KAFKA_BROKER_URL_ID: 1
20      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
21      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://localhost:9092
22      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
23      KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
24      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
25      KAFKA_AUTO_CREATE_TOPICS_ENABLE: 'true'
26      KAFKAJS_NO_PARTITIONER_WARNING: 1
27      KAFKA_NUM_PARTITIONS: '6'

Now run the both services in your machine and hit the API. 🥳

Back To The Top

---

👌 Test

• Fork it 😎
• Clone forked repository: git clone https://github.com/username/forked-name.git
• Install the dependencies from root directory: npm install
• Rename .env.example to .env
• Now run: npm run test & see the results 😎

---

💡 How To Contribute

• Fork it 😎
• Create a feature branch: git checkout -b my-feature
• Add your changes: git add .
• Commit your changes: git commit -m 'My new feature'
• Push to the branch: git push origin my-feature
• Submit a pull request

Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project

Back To The Top

---

📈 Project Activity

Back To The Top

---

👤 Author

🤓 Md. Muhtasim Fuad Fahim mdmuhtasim.fahim@gmail.com

• Github: @mdmuhtasimfuadfahim
• LinkedIn: @mdmuhtasimfuadfahim

Back To The Top

---

🔏 License

Copyright © 2023 Md. Muhtasim Fuad Fahim

This project is licensed by MIT License.

Back To The Top

---