Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arulrajnet/cookiecutter-gradle-java-template
Cookiecutter for gradle based java project.
https://github.com/arulrajnet/cookiecutter-gradle-java-template
cookiecutter cookiecutter-template gradle java
Last synced: about 1 month ago
JSON representation
Cookiecutter for gradle based java project.
- Host: GitHub
- URL: https://github.com/arulrajnet/cookiecutter-gradle-java-template
- Owner: arulrajnet
- License: mit
- Created: 2018-04-22T11:23:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-29T10:10:18.000Z (over 6 years ago)
- Last Synced: 2024-11-09T04:36:32.343Z (3 months ago)
- Topics: cookiecutter, cookiecutter-template, gradle, java
- Language: XSLT
- Homepage:
- Size: 96.7 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
[[cookiecutter-gradle-java-template]]
= Gradle Java Templates
Java project template using cookiecutter
:toc: left
:icons: font
== How to use
* Install python and pip
sudo apt-get install python python-pip -y
* Install cookiecutter
sudo pip install -U cookiecutter
Then
cookiecutter https://github.com/arulrajnet/cookiecutter-gradle-java-template
The output screen would be
copyright_name [My Dream Inc.,]: JCrawler Inc.,
Select license:
1 - Proprietary
2 - MIT
3 - GNU GPL v3.0
4 - Apache Software License 2.0
Choose from 1, 2, 3, 4 [1]: 1
project_display_name [My Java App]: Crawler App
project_name [myapp]: jcrawler
package_name [com.githup.mydream]: io.jcrawler.app
project_short_description [A cookiecutter template for creating reusable Java projects quickly]: To Be Done
== Project Structure
jcrawler
├── gradle <1>
│ ├── config
│ │ ├── git <2>
│ │ └── jdepend <3>
│ └── wrapper
└── src
├── docs
│ └── asciidoc <4>
│ └── stylesheets
├── main
│ ├── java
│ │ └── io
│ │ └── jcrawler
│ │ └── app <5>
│ └── resources
└── test
├── java
│ └── io
│ └── jcrawler
│ └── app <6>
└── resources
<1> All gradle related files
<2> Git hooks
<3> Jdepend style sheet
<4> Asciidoc files for the project
<5> Source files.
<6> Test files.
== License
Selecting license for a project is configurable. Supported licenses are
* MIT
* GNU GPL v3.0
* Apache Software License 2.0
* Proprietary.
By default Proprietary is selected.
License text are from https://choosealicense.com/ and https://opensource.org/licenses/
License plugin configured in link:https://github.com/arulrajnet/cookiecutter-gradle-java-template/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/gradle/license.gradle[license.gradle]
== Code Quality
The following code analysis tools are configured in link:https://github.com/arulrajnet/cookiecutter-gradle-java-template/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/gradle/quality.gradle[quality.gradle]
* PMD
* CheckStyle
* FindBugs
* JDepend
* JaCoCo
* Sonar
== Code Formatting
Code formatting done using Spotless which is configured in link:https://github.com/arulrajnet/cookiecutter-gradle-java-template/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/gradle/spotless.gradle[spotless.gradle]
== Asciidoctor for docs
Docs for project can be written in link:https://asciidoctor.org/docs/user-manual/[AssciiDoctor]
Gradle configuration in link:https://github.com/arulrajnet/cookiecutter-gradle-java-template/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/gradle/doc.gradle[doc.gradle]
== IDE
Both Eclipse and IntelliJ are configured in link:https://github.com/arulrajnet/cookiecutter-gradle-java-template/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/gradle/ide.gradle[ide.gradle]
== Git Hooks
`commit-msg` and `pre-push` git hooks are configured in link:https://github.com/arulrajnet/cookiecutter-gradle-java-template/blob/master/%7B%7Bcookiecutter.project_name%7D%7D/gradle/git.gradle[git.gradle]
== Java
Java 1.8
Gradle 3.5