nayrid.com / java-template
Opinionated java-library project template
fork atom
Shell 79.8%
Batchfile 15.9%
Kotlin 2.7%
Java 1.5%
Other 0.1%
11 1 0

Clone this repository

https://tangled.org/nayrid.com/java-template https://tangled.org/did:plc:f2k3lo7oz45ajmpmnbwtyz62/java-template
git@tangled.org:nayrid.com/java-template git@tangled.org:did:plc:f2k3lo7oz45ajmpmnbwtyz62/java-template

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
readme.md

template#

This template is marked CC0 1.0.

The license.txt and license_header.txt this template provides are MIT. You will want to change them if your project will be released under a different license. Remember to change the license declaration in base-conventions.gradle.kts too.

Quick start#

Run the rename script to set your group, project name, and Java package:

./.scripts/rename-template.sh -g "com.acme" -p "my-project" -n "acmeRepo" -s "https://repo.acme.com/snapshots" -r "https://repo.acme.com/releases" -a "Acme, Inc." -y "2026"

Checkstyle#

This template uses checkstyle. For checkstyle support in IntelliJ IDEA:

  1. Install the checkstyle plugin.
  2. In the Checkstyle tab, set the configuration file to .checkstyle/checkstyle.xml.