Installation¶

System Requirements¶

Dependency Installation¶

Gradle¶

Add to your build.gradle:

repositories {
    mavenCentral()
}

dependencies {
    implementation 'io.github.closeup1202:curve:0.2.0'
}

Maven¶

Add to your pom.xml:

<dependencies>
    <dependency>
        <groupId>io.github.closeup1202</groupId>
        <artifactId>curve</artifactId>
        <version>0.2.0</version>
    </dependency>
</dependencies>

Optional Dependencies¶

Avro Serialization¶

If you want to use Avro serialization (serde.type: AVRO), add:

repositories {
    mavenCentral()
    maven { url 'https://packages.confluent.io/maven/' }
}

dependencies {
    implementation 'org.apache.avro:avro:1.11.4'
    implementation 'io.confluent:kafka-avro-serializer:8.1.1'
}

<repositories>
    <repository>
        <id>confluent</id>
        <url>https://packages.confluent.io/maven/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.apache.avro</groupId>
        <artifactId>avro</artifactId>
        <version>1.11.4</version>
    </dependency>
    <dependency>
        <groupId>io.confluent</groupId>
        <artifactId>kafka-avro-serializer</artifactId>
        <version>7.5.0</version>
    </dependency>
</dependencies>

Database for Transactional Outbox¶

If using the transactional outbox pattern, ensure you have a JPA-compatible database:

// Example: PostgreSQL
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
runtimeOnly 'org.postgresql:postgresql'

Version Compatibility¶

Verify Installation¶

After adding the dependency, verify Curve is correctly installed:

1. Build Your Project¶

./gradlew clean build

./mvnw clean install

2. Check Auto-Configuration¶

Enable debug logging to see if Curve auto-configuration is loaded:

logging:
  level:
    io.github.closeup1202.curve: DEBUG

Start your application and look for:

CurveAutoConfiguration matched:
   - @ConditionalOnProperty (curve.enabled=true) matched

3. Test Health Endpoint¶

curl http://localhost:8080/actuator/health/curve

Expected response:

{
  "status": "UP",
  "details": {
    "kafkaProducerInitialized": true,
    "clusterId": "lkc-abc123",
    "nodeCount": 3,
    "topic": "event.audit.v1",
    "dlqTopic": "event.audit.dlq.v1"
  }
}

Troubleshooting¶

Dependency Resolution Fails¶

repositories {
    mavenCentral()
}

./mvnw dependency:purge-local-repository

Auto-Configuration Not Loading¶

Kafka Client Version Conflict¶

dependencies {
    implementation('io.github.closeup1202:curve:0.2.0') {
        exclude group: 'org.apache.kafka'
    }
    implementation 'org.apache.kafka:kafka-clients:3.8.0'
}

Next Steps¶

Once installed, proceed to:

1. Quick Start Guide - Create your first event
2. Configuration - Set up production settings
3. First Event Tutorial - Detailed walkthrough