Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.54 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.54 KB

Java Template

License: GPL v3 CodeQL

This is the template repository that I use for all of my Java projects.

Features

  • 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

How to Use

  1. Clone the repository.
  2. Open the project in your favorite IDE (preferably IntelliJ IDEA).
  3. Modify the project to your liking using the TODO comments.
  4. Build the project using build, jar, or shadowJar.
  5. Enjoy the template!

Things to Change

  • 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 the build.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.

Getting Help

For support or queries, please open an issue in the Issues section.