Skip to content

Utility package providing domain model classes and DTOs for services of the Superb Data Kraken Platform (SDK).

License

Notifications You must be signed in to change notification settings

EFS-OpenSource/superb-data-kraken-common

Repository files navigation

sdk-common package

License Java Version


About

The sdk-common package is a utility package providing domain model classes and DTOs for services of the Superb Data Kraken Platform (SDK).

For a more detailed understanding of the broader context of the platform this package is used in, refer to the architecture documentation. (#TODO)

For a comprehensive guide on installing the SDK, refer to the installation instructions. (#TODO)

Getting Started

Follow the instructions below to set up a local copy of the project for development and testing.

Prerequisites

  • jdk >= 17
  • Maven 3.6.x (if you're not using the Maven wrapper)

Setup

To set up your local environment for development and testing, follow these steps:

  1. Clone the repository:
    git clone https://github.com/EFS-OpenSource/superb-data-kraken-common.git
    cd superb-data-kraken-common
  2. Build the project and install the package to your local Maven repository:
    ./mvnw clean install
    

Usage

To include this module in your project, simply add the following dependency declaration to the section of your pom.xml:

<dependency>
   <groupId>com.efs.sdk</groupId>
   <artifactId>sdk-common</artifactId>
   <version>${version}</version>
</dependency>

Built With

Links to tools used for building. Example:

  • Maven v3.6.3 (see this Link)

Contributing

See the Contribution Guide.

Changelog

See the Changelog.

About

Utility package providing domain model classes and DTOs for services of the Superb Data Kraken Platform (SDK).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages