klunge/klungeframework

Klunge is a platform for Event Sourcing and CQRS to build scalable event-driven and eventual consistent systems

Klunge

Offical Website: klunge.io

Enterprise-Scale Eventually Consistent CQRS Framework

Klunge is a Java based Event Sourcing framework which can be benefited by the teams who are planning to make CQRS transitions with minimum learning curve and ease of adaptation.

It has a unique architecture called Operation Store™ together with the stack elements including Docker, Kafka, Hazelcast and Cassandra.

You can reach various samples from this link Demo

Installation

If you're using MAVEN, you have to add this properties to super pom file.

.m2/settings.xml

<?xml version="1.0" encoding="UTF-8" ?>
<settings xsi:schemaLocation='http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd'
          xmlns='http://maven.apache.org/SETTINGS/1.0.0' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
    <profiles>
        <profile>
            <repositories>
                <repository>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <id>bintray-kloia-eventapis</id>
                    <name>bintray</name>
                    <url>https://dl.bintray.com/kloia/eventapis</url>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <snapshots>
                        <enabled>false</enabled>
                    </snapshots>
                    <id>bintray-kloia-eventapis</id>
                    <name>bintray-plugins</name>
                    <url>https://dl.bintray.com/kloia/eventapis</url>
                </pluginRepository>
            </pluginRepositories>
            <id>bintray</id>
        </profile>
    </profiles>
    <activeProfiles>
        <activeProfile>bintray</activeProfile>
    </activeProfiles>
</settings>

If you're using gradle add this property to gradle file

repositories {
    maven {
        url  "https://dl.bintray.com/kloia/eventapis" 
    }
}

for another using options you can visit Bintray Repo

Usage

You have to add properties to pom.xml

<dependencies>
    <dependency>
        <groupId>com.kloia.eventapis</groupId>
        <artifactId>spring-integration</artifactId>
        <version>0.7.0</version>
    </dependency>
    <dependency>
        <groupId>com.kloia.eventapis</groupId>
        <artifactId>spring-jpa-view</artifactId>
        <version>0.7.0</version>
    </dependency>
    <dependency>
        <groupId>com.kloia.eventapis</groupId>
        <artifactId>java-api</artifactId>
        <version>0.7.0</version>
    </dependency>
</dependencies>

External Dependencies

You have to add properties to pom.xml, too.

<dependencies>
	<dependency>
		<groupId>org.apache.commons</groupId>
		<artifactId>commons-lang3</artifactId>
		<version>3.9</version>
	</dependency>
	<dependency>
		<groupId>org.apache.commons</groupId>
		<artifactId>commons-collections4</artifactId>
		<version>4.4</version>
	</dependency>
	<dependency>
		<groupId>com.datastax.cassandra</groupId>
		<artifactId>cassandra-driver-core</artifactId>
		<version>3.8.0</version>
	</dependency>
	<dependency>
		<groupId>pl.touk</groupId>
		<artifactId>throwing-function</artifactId>
		<version>1.3</version>
	</dependency>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-openfeign</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.kafka</groupId>
		<artifactId>spring-kafka</artifactId>
	</dependency>
	<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

Prerequisites

Before run your built services you have to run Docker Compose it will run minumum external resources Cassandra, Kafka etc.

Build

If you're using different java versions you have to set in bash prompt before run at bottom of commands, you can use SDKMAN

  $ mvn clean install
  $ mvn clean compile

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

Apache License