This is the template repository that I use for all of my Java projects.
- Templates for pull requests, bugs, improvements, features, and questions
- Code of Conduct, Contributing, and Security guidelines
- GitHub Actions for building, dependency checking, and code scanning
- Gradle build system with Shadow plugin for creating shaded JARs
- Lombok and JetBrains Annotations dependencies for cleaner code
- Clone the repository.
- Open the project in your favorite IDE (preferably IntelliJ IDEA).
- Modify the project to your liking using the
TODO
comments. - Build the project using
build
,jar
, orshadowJar
. - Enjoy the template!
- Change the
README.md
file to your own project information. - Change the
LICENSE
file to your own license (default is GPL v3). - Change the issue templates and labels in the
.github/ISSUE_TEMPLATE
directory. - Remove the
shadow
plugin from thebuild.gradle
file if you don't want to use it. - Remove the pre-existing dependencies from the
build.gradle
file if you don't want to use them.
For support or queries, please open an issue in the Issues section.