@dtu-olp-2024/kafka-nocobase/README.md

A NocoBase plugin for Apache Kafka integration, supporting message publishing, topic management, and event-driven workflows. Built for the DTU GreenHope project.

# Kafka NocoBase Plugin

## 🌟 Giới Thiệu

`@olp-dtu-2024/kafka-nocobase` là một plugin cho nền tảng NocoBase, tích hợp KafkaJS giúp đơn giản hóa việc xử lý các sự kiện và giao tiếp message trong ứng dụng NocoBase của bạn.

### 🏆 Bối Cảnh
Plugin được phát triển như một phần của cuộc thi Mã Nguồn Mở năm 2024.

## ✨ Tính Năng

- 🔗 Tích hợp dễ dàng KafkaJS với NocoBase
- 📩 Hỗ trợ gửi và nhận message từ các Kafka topic
- 🔧 Quản lý kết nối Kafka hiệu quả
- 🌐 Tương thích với phiên bản NocoBase 1.x

## 🚀 Cài Đặt

### Sử Dụng npm:

```bash
npm install @olp-dtu-2024/kafka-nocobase
```

### Sử Dụng Yarn:

```bash
yarn add @olp-dtu-2024/kafka-nocobase
```

## 📋 Yêu Cầu Tiên Quyết

- Node.js version 18.x trở lên
- NocoBase phiên bản 1.x
- KafkaJS phiên bản 2.2.4 trở lên

## 👥 Tác Giả

- Lê Minh Tuấn
- Trần Nguyễn Duy Khánh

## 📄 Giấy Phép

Dự án được phân phối dưới giấy phép **GNU General Public License v3.0**

## 🤝 Đóng Góp

Chúng tôi rất hoan nghênh các đóng góp từ cộng đồng! Vui lòng:

- Tạo issue để báo cáo lỗi
- Gửi pull request để đề xuất cải tiến
- Truy cập GitHub Repository của chúng tôi để biết thêm chi tiết

## 🆘 Hỗ Trợ

Nếu gặp bất kỳ vấn đề nào, vui lòng:
- Mở issue tại GitHub repository
- Liên hệ trực tiếp với nhóm phát triển

## ⚠️ Lưu Ý

- Đảm bảo kết nối mạng ổn định
- Kiểm tra cấu hình Kafka trước khi sử dụng
- Tuân thủ best practices về message queue

---

**Được phát triển với ❤️ bởi Nhóm DTU-GreenHope**