Skip to content

🖨 Template for Kafka processor projects @okp4.

License

Notifications You must be signed in to change notification settings

okp4/template-kafka-processor

Kafka Processor Template

Template for Kafka Streams Processor project @okp4.

version build lint test conventional commits contributor covenant License

Purpose

TBD

Implementation

Implementation mainly relies on Kafka Streams API, library to create event-stream applications with the following features:

  • no external dependency other than Kafka itself,
  • simple and light library,
  • fault-tolerant and scalable.

Moreover, this implementation:

  • uses Kotkin as primary coding language,
  • is as much as possible, lean, i.e. tries to minimize the dependencies to 3rd party libraries and the resulting package footprint.

Build

This project targets the JVM 11+, so be sure to have it available in your environment.

This project relies on the Gradle build system.

If you are on windows then open a command line, go into the root directory and run:

.\gradlew build

If you are on linux/mac then open a terminal, go into the root directory and run:

./gradlew build

This command line produces 2 JAR files:

  • a regular JAR: kafka-processor-X.Y.jar
  • a fat JAR: kafka-processor-X.Y-standalone.jar

This last one is the one to use as it contains all the dependencies in it.

You want to get involved? 😍

Please check out OKP4 health files :