StreamSight

StreamSight is a lightweight yet powerful web application built to consume and produce real-time Kafka events via a Socket.IO interface. Developed with KafkaJS, it offers a streamlined way to work with real-time data streams.

Frontend Repository can be found from here.

Frontend Configuration

Please follow the instructions in the here to set up and configure the frontend.

Prerequisites

Ensure the following tools are installed:

• Node.js (v16.x or higher)
• Kafka (locally or via a cloud provider such as Confluent Cloud)
• npm or yarn

Steps

1. Clone the repository

   git clone https://github.com/DamianRavinduPeiris/kafka-ts.git
   

2. Navigate to the project directory

   cd kafka-ts
   

3. Install dependencies Using npm:

   npm install

   Or using yarn:

   yarn install
   

4. Create an .env file in project root and add KAFKA_BROKERS property which contains your cluster endpoint(s).If you have multiple endpoints,seperate them with commas.

5. Start the application Using npm:

   npm run dev

   Or using yarn:

   yarn start

Screenshots

1) Producing Events

2) Consuming Events

3) Searching Through Consumed Events

Contribution Guidelines

Contributions are welcome! Here's how you can contribute:

1. Fork the repository.
2. Create a new feature branch:

   git checkout -b feature/your-feature-name
   

3. Commit your changes:

   git commit -m "Add your feature description"
   

4. Push the branch:

   git push origin feature/your-feature-name
   

5. Open a pull request.

Reporting Issues

If you encounter any issues, please open an issue in the repository with a detailed description.

License

This project is licensed under the MIT License.

Made with ❤️ by Damian.