Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonatan-ivanov/gradle-ghost

You can't see it but it's there: Gradle Ghost is esentially a set of build scripts that help you to easily build your projects using Gradle.
https://github.com/jonatan-ivanov/gradle-ghost

build build-tools gradle gradle-ghost groovy hacktoberfest java jvm

Last synced: 15 days ago
JSON representation

You can't see it but it's there: Gradle Ghost is esentially a set of build scripts that help you to easily build your projects using Gradle.

Host: GitHub
URL: https://github.com/jonatan-ivanov/gradle-ghost
Owner: jonatan-ivanov
License: apache-2.0
Created: 2020-09-20T06:39:42.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2021-05-17T06:18:27.000Z (over 3 years ago)
Last Synced: 2025-01-06T14:56:34.229Z (18 days ago)
Topics: build, build-tools, gradle, gradle-ghost, groovy, hacktoberfest, java, jvm
Language: Shell
Homepage:
Size: 92.8 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Gradle Ghost

You can't see it but it's there: Gradle Ghost is esentially a set of build scripts that help you to easily build your projects using [Gradle](https://docs.gradle.org/current/userguide/userguide.html)

# What is this exactly?

[![asciicast](https://asciinema.org/a/364593.svg)](https://asciinema.org/a/364593)

It's a tool built on top of [Gradle](https://docs.gradle.org/current/userguide/userguide.html) to help you creating and building simple java-based projects.  

It sets-up everything for you to kick-start your project, you only need an empty directory, you will get:

- The latest [OpenJDK](https://openjdk.java.net/), only if you don't have any Java installation

- The latest [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) and [Gradle](https://docs.gradle.org/current/userguide/userguide.html) if you don't have it

- A [git](https://git-scm.com/) repo (with `.gitignore`)

- An [EditorConfig](https://editorconfig.org/) file

- A HelloWorld app and a unit test

- A few pre-configured Gradle scripts so that you don't need to write them (you can owerride them), you will get

  - A Java project which just works

    - Building jars (executable, sources, javadoc): `grg assemble`

    - Executing the tests: `grg test`

    - Running the project: `grg run`

    - Generating IDE files ([IntelliJ IDEA](https://www.jetbrains.com/idea/)): `grg idea`

    - etc. see: `grg tasks --all`

  - Generated version numbering

  - [Dependenvy locking](https://docs.gradle.org/current/userguide/dependency_locking.html)

  - A couple of basic libraries ([Lombok](https://projectlombok.org/), [Slf4J](http://www.slf4j.org/), [JUnit5](https://junit.org/junit5/))

# Installing

You can install Gradle Ghost via curl:  

`sh -c "$(curl -fsSL https://raw.githubusercontent.com/jonatan-ivanov/gradle-ghost/main/bin/install)"`  

or via wget:  

`sh -c "$(wget -qO- https://raw.githubusercontent.com/jonatan-ivanov/gradle-ghost/main/bin/install)"`  

or via fetch:  

`sh -c "$(fetch -o - https://raw.githubusercontent.com/jonatan-ivanov/gradle-ghost/main/bin/install)"`

(On Windows, you need to run your terminal app as admin)

# Dependencies

Standard Unix Tools, `git`, `curl`

# Testing

You can play with the tool using the `Dockerfile` in the project root:

```sh

docker build . -t gradle-ghost

docker run --rm -it gradle-ghost

```