Gradle 'Getting Started' template
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config/checkstyle
gradle
src/java
test/groovy
.gitignore
LICENSE.txt
README.md
build.gradle
gradleinit
gradlew
gradlew.bat

README.md

About

Opinionated Gradle getting started template as a good starting point for the project. The focus here on the simplicity, and the use of code quality and static analysis tools:

  • JaCoCo - for test coverage
  • Checkstyle - for standardize and control the style between members in the team
  • PMD/FindBugs - to spot any potential bug places and establish best practices
  • Spock Framework - as the flexible testing framework for Java project

The versions of the tools used in this template see below in the table.

Read more about Gradle 'Getting Started' template

How to use it

Via script (recommended)

  • download and put gradleinit script into bin folder
  • run gradleinit or gradleinit <project name>
  • provide the project name script asks for (if run without project name specified)
  • add your remote location git remote add origin <your remote location>

Manually

  • clone the repository git clone https://github.com/zshamrock/gradle-getting-started-template.git <your project name>
  • unlink remote git remote rm origin
  • add your remote location git remote add origin <your remote location>
  • add all files into Git git add .
  • commit your changes git commit -m "Getting started"
  • push your changes into the remote repository git push -u origin master

Tools versions

Gradle Groovy Java PMD Checkstyle FindBugs JDepend JaCoCo
2.10 (released 21st December 2015) 2.4.5 (released 7th September 2015) 1.8 5.4.1 (released 4th December 2015) 6.13 (released 30th November 2015) 3.0.1 (release 6th March 2015) 2.9.1 (released 22nd August 2008) 0.7.5.201505241946 (released 24th May 2015)

License

The MIT License (MIT)

Copyright (c) 2015 Aliaksandr Kazlou

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.