Gradle Template

🏕️ Project Template

This repo contains a Gradle project structure with:

• Centralized and maintainable build configuration and custom build logic
• No dependency hell through smart dependency management with dependency rules and analysis

The starter project contains everything for a traditional JVM project. The structure though, is good for any kind of project you may build with Gradle (Kotlin, Groovy, Scala, ...).

🧱 Project Overview

You can find a detailed explanation of the project structure in Gradle Basics.

Core Concepts

Project Structure

project
├── gradle
│   ├── libs.versions.toml
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle(.kts)
├── subproject-a
│   ├── build.gradle(.kts)
│   └── src
└── subproject-b
    ├── build.gradle(.kts)
    └── src

Build Lifecycle

Configuration Cache

The Configuration Cache improves build performance by caching the result of the configuration phase and reusing it for subsequent builds.

Dependency Scopes

Mapping between Java module directives and Gradle configurations to declare dependencies: declaring_module_dependencies

🍰 Project Usage

Using Make (Recommended)

This project includes a Makefile with standardized commands that work across all operating systems:

make help              # Show all available commands
make run               # Run the main application
make build             # Build the entire project
make test              # Run all tests
make check             # Run all checks (format, lint, tests)

Quick Reference

Command	Description
make run	Run the main application (app module)
make build	Build the entire project
make build-fast	Build without tests (faster)
make test	Run all tests
make test-coverage	Run tests with coverage report
make format	Format all code (Spotless)
make check	Run all checks (format + lint + tests)
make clean	Clean build artifacts
make deps	Show project dependencies

Examples

# Quick development cycle
make format build-fast

# Run specific example
make run-java      # Run Java example
make run-kotlin    # Run Kotlin example
make run-spring    # Run Spring example

# Full CI pipeline
make all          # clean + build + test + check

Using Gradle Directly

You can also run ./gradlew help to get Gradle command-line usage help.

./gradlew help                    # Show Gradle help
./gradlew build                   # Build project
./gradlew app:run                 # Run app module
./gradlew test                    # Run tests
./gradlew check                   # Run all checks

Initial Setup

Make the Gradle wrapper executable:

git update-index --chmod=+x gradlew
# Or use make:
make setup

🏝️ Thanks

This project is heavily inspired by the following awesome projects.

• https://github.com/jjohannes/gradle-project-setup-howto
• https://github.com/hiero-ledger/hiero-gradle-conventions
• https://github.com/android/nowinandroid