https://github.com/astrapi69/java-library-template

Template project for create java library projects
https://github.com/astrapi69/java-library-template

java library

Last synced: 2 months ago
JSON representation

Template project for create java library projects

Host: GitHub
URL: https://github.com/astrapi69/java-library-template
Owner: astrapi69
License: mit
Created: 2021-01-14T11:04:13.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-10-16T16:05:04.000Z (about 1 year ago)
Last Synced: 2024-10-18T07:24:17.502Z (about 1 year ago)
Topics: java, library
Language: Java
Homepage:
Size: 241 KB
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


[![Build Status](https://github.com/astrapi69/java-library-template/actions/workflows/gradle.yml/badge.svg)](https://github.com/astrapi69/java-library-template/actions/workflows/gradle.yml)

[![Coverage Status](https://codecov.io/gh/astrapi69/java-library-template/branch/develop/graph/badge.svg)](https://codecov.io/gh/astrapi69/java-library-template)

[![Open Issues](https://img.shields.io/github/issues/astrapi69/java-library-template.svg?style=flat)](https://github.com/astrapi69/java-library-template/issues)

[![Maven Central](https://img.shields.io/maven-central/v/io.github.astrapi69/java-library-template?style=plastic)](https://search.maven.org/artifact/io.github.astrapi69/java-library-template)

[![Javadocs](http://www.javadoc.io/badge/io.github.astrapi69/java-library-template.svg)](http://www.javadoc.io/doc/io.github.astrapi69/java-library-template)

[![MIT License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](http://opensource.org/licenses/MIT)

[![Donate](https://img.shields.io/badge/donate-❤-ff2244.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=GVBTWLRAZ7HB8)

[![Hits Of Code](https://hitsofcode.com/github/astrapi69/java-library-template?branch=develop)](https://hitsofcode.com/github/astrapi69/java-library-template/view?branch=develop)



# Overview

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

[wiki](https://github.com/astrapi69/java-library-template/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 [![donation](https://img.shields.io/badge/donate-❤-ff2244.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=GVBTWLRAZ7HB8)

# 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](https://asterios-raptis.medium.com/new-github-template-repository-feature-ec09afe261b8)

## 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: [![Maven Central](https://img.shields.io/maven-central/v/io.github.astrapi69/java-library-template?style=plastic)](https://search.maven.org/artifact/io.github.astrapi69/java-library-template)

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](https://oss.sonatype.org/index.html#nexus-search;gav~io.github.astrapi69~java-library-template~~~)

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:

    

        ...

```xml

        

        ${latestVersion}

```

        ...

    

        ...

        

        ...

```xml

            

            

                io.github.astrapi69

                java-library-template

                ${java-library-template.version}

            

```

        ...

        

  Snapshots (click to expand)

## 📸 Snapshots

[![Snapshot](https://img.shields.io/badge/dynamic/xml?url=https://oss.sonatype.org/service/local/repositories/snapshots/content/io/github/astrapi69/java-library-template/maven-metadata.xml&label=snapshot&color=red&query=.//versioning/latest)](https://oss.sonatype.org/content/repositories/snapshots/io/github/astrapi69/java-library-template/)

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 {

   //...

```

```groovy

    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:

`..`

For detailed information on versioning you can visit

the [wiki page](https://github.com/lightblueseas/mvn-parent-projects/wiki/Semantic-Versioning).

## 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](https://github.com/astrapi69/java-library-template/fork)

To share your changes, [submit a pull request](https://github.com/astrapi69/java-library-template/pull/new/develop).

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](https://github.com/astrapi69/java-library-template/issues).

## Credits

|**Nexus Sonatype repositories**|

|     :---:      |

|[![sonatype repository](https://img.shields.io/nexus/r/https/oss.sonatype.org/io.github.astrapi69/java-library-template.svg?style=for-the-badge)](https://oss.sonatype.org/index.html#nexus-search;gav~io.github.astrapi69~java-library-template~~~)|

|Special thanks to [sonatype repository](https://www.sonatype.com) for providing a free maven repository service for open source projects|

|          |

|**codecov.io**|

|     :---:      |

|[![Coverage Status](https://codecov.io/gh/astrapi69/java-library-template/branch/develop/graph/badge.svg)](https://codecov.io/gh/astrapi69/java-library-template)|

|Special thanks to [codecov.io](https://codecov.io) for providing a free code coverage for open source projects|

|          |

|**javadoc.io**|

|     :---:      |

|[![Javadocs](http://www.javadoc.io/badge/io.github.astrapi69/java-library-template.svg)](http://www.javadoc.io/doc/io.github.astrapi69/java-library-template)|

|Special thanks to [javadoc.io](http://www.javadoc.io) for providing a free javadoc documentation for open source projects|

|          |

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/astrapi69/java-library-template

Awesome Lists containing this project

README