Skip to content

Template project for create kotlin library projects

License

Notifications You must be signed in to change notification settings

astrapi69/kotlin-library-template

Repository files navigation

Overview

Build Status Coverage Status Open Issues Maven Central Javadocs MIT license Donate

Template project for create kotlin library projects.

If you like this project put a ⭐ and donate

Template from this project

You can derive your kotlin library project from this you can easily and adapt to your specific project if you follow the instruction from this medium blog

Note

No animals were harmed in the making of this library.

Donations

If you like this library, please consider a donation through paypal: PayPal this

or over bitcoin or bitcoin-cash with:

36JxRRDfRazLNqUV6NsywCw1q7TK38ukpC

or over ether with:

0x588Aa02De98B1Ef70afeDC3ec5290130a3E5e273

or over flattr: Flattr this

License

The source code comes under the liberal MIT License, making kotlin-library-template great for all types of applications.

Maven dependency

Maven dependency is now on sonatype. Check out sonatype repository for latest snapshots and releases.

Add the following maven dependency to your project pom.xml if you want to import the core functionality of kotlin-library-template:

Than you can add the dependency to your dependencies:

<properties>
        ...
    <!-- kotlin-library-template version -->
    <kotlin-library-template.version>1</kotlin-library-template.version>
        ...
</properties>
        ...
    <dependencies>
        ...
        <!-- kotlin-library-template DEPENDENCY -->
        <dependency>
            <groupId>io.github.astrapi69</groupId>
            <artifactId>kotlin-library-template</artifactId>
            <version>${kotlin-library-template.version}</version>
        </dependency>
        ...
    </dependencies>

gradle dependency

You can first define the version in the ext section and add than the following gradle dependency to your project build.gradle if you want to import the core functionality of kotlin-library-template:

define version in file gradle.properties

kotlinLibraryTemplateVersion=1

or in build.gradle ext area

ext {
            ...
    kotlinLibraryTemplateVersion = "1"
            ...
}

and than add the dependency to the dependencies area

dependencies {
            ...
    implementation("io.github.astrapi69:kotlin-library-template:kotlinLibraryTemplateVersion")
            ...
}

Semantic Versioning

The versions of kotlin-library-template are maintained with the Semantic Versioning guidelines.

Release version numbers will be incremented in the following format:

<major>.<minor>.<patch>

For detailed information on versioning you can visit the wiki page.

Want to Help and improve it?

The source code for kotlin-library-template are on GitHub. Please feel free to fork and send pull requests!

Create your own fork of astrapi69/kotlin-library-template/fork

To share your changes, submit a pull request.

Don't forget to add new units tests on your changes.

Contacting the Developers

Do not hesitate to contact the kotlin-library-template developers with your questions, concerns, comments, bug reports, or feature requests.

  • Feature requests, questions and bug reports can be reported at the issues page.

Similar projects

Credits