Overview

Template project for create java library projects. A small documentation how to use this template project in in the wiki

Please support this project by simply putting a Github Star ⭐

Share this library with friends on Twitter and everywhere else you can

If you love this project

Template from this project

You can derive your java 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.

License

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

Import dependencies to your project

gradle (click to expand)

gradle dependency

Replace the variable ${latestVersion} with the current latest version:

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 java-library-template:

define version in file gradle.properties

javaLibraryTemplateVersion=${latestVersion}

or in build.gradle ext area

    javaLibraryTemplateVersion = "${latestVersion}"

then add the dependency to the dependencies area

    implementation("io.github.astrapi69:java-library-template:$javaLibraryTemplateVersion")

with new libs.versions.toml file

If you use the new libs.versions.toml file for new automatic catalog versions update

[versions]

java-library-template-version= "${latestVersion}"

[libraries]

java-library-template = { module = "io.github.astrapi69:java-library-template", version.ref = "java-library-template-version" }

then add the dependency to the dependencies area

    implementation libs.java.library.template

Maven (click to expand)

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 java-library-template:

Then you can add the dependency to your dependencies:

<properties>
    ...

        <!-- java-library-template version -->
        <java-library-template.version>${latestVersion}</java-library-template.version>

    ...
</properties>
    ...
    <dependencies>
    ...

            <!-- java-library-template DEPENDENCY -->
            <dependency>
                <groupId>io.github.astrapi69</groupId>
                <artifactId>java-library-template</artifactId>
                <version>${java-library-template.version}</version>
            </dependency>

    ...
    </dependencies>

Snapshots (click to expand)

📸 Snapshots

This section describes how to import snapshot versions into your project. Add the following code snippet to your gradle file in the repositories section:

repositories {
   //...

    maven {
        name "Sonatype Nexus Snapshots"
        url "https://oss.sonatype.org/content/repositories/snapshots"
        mavenContent {
            snapshotsOnly()
        }
    }

}

Donations

This project is kept as an open source product and relies on contributions to remain being developed. If you like this library, please consider a donation

over paypal:



or over bitcoin(BTC) with this address:

bc1ql2y99q7e8psndhcc3gferk03esw3qqf677rhjy

or over FIO with this address:

FIO7tFMUVAA9cHiPPqKMfMXiSxHrbpiFyRYqTketNuM67aULuwjop

or over Ethereum(ETH) with:

0xc057D159D3C8f3311E73568b334FF6fE82EB2b7D

or over Ethereum Classic(ETC) with:

0xF708cA86D86C246B69c3F4BAe431eBbe0c2bfddD

or over Dogecoin(DOGE) with:

D5yi4Um8cpakd6yPRm2hGWuQ5nrVzhSSW1

or over Monero(XMR) with:

49bqeRQ7Bf49oJFVC72pqpe5hFbb62pfXDYPdLsadGGF81KZW2ZfrPZ8PbAVu5X2v1TYAspeczMya3cYQysNS4usRRPQHVw

or over the donation buttons at the top.

Semantic Versioning

The versions of java-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.

What can i do to support this project

You can donate or contribute solve issues or pull request. Every support are welcome.

Want to Help and improve it?

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

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

To share your changes, submit a pull request.

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

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or improvements.

Contacting the Developers

Do not hesitate to contact the java-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.

Credits

Nexus Sonatype repositories
Special thanks to sonatype repository for providing a free maven repository service for open source projects

codecov.io
Special thanks to codecov.io for providing a free code coverage for open source projects

javadoc.io
Special thanks to javadoc.io for providing a free javadoc documentation for open source projects