isabella232 / hazelcast-gradle-starter

Quick start Hazelcast with Gradle

Table of content

• How To Use
• What’s in a box?
  • Directory layout
  • Run your Hazelcast application
  • Produce UberJar
  • Start Hazelcast Member Node

Here is an example how to quickly start a new Hazelcast Project with Gradle.

How To Use

1. Clone this repository

   git clone [email protected]:hazelcast/hazelcast-gradle-starter.git

2. Remove Hazelcast’s origin

   git remote remove origin

3. Add YOUR own origin and start coding

   git remote add origin https://github.com/awesome_user/awesome_project

4. PROFIT!!!

   

What’s in a box?

• Gradle Wrapper FTW! No need to have Gradle installed.

• build.gradle with Hazelcast repositories (including Enterprise and SNAPSHOTS)

• Easy Hazelcast version management with gradle.properties

• Hazelcast dependencies (including Testing Framework)

• UberJar configuration via shadow Gradle plugin.

Directory layout

.
├── README.adoc                     #(1)
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties                   #(2)
├── gradlew                             #(3)
├── gradlew.bat                         #(3)
├── hazelcast-gradle-starter.iml
├── settings.gradle
└── src
    └── main
        ├── java
        │   └── com
        │       └── hazelcast
        │           └── gradle
        │               └── starter
        │                   └── Starter.java   #(4)
        └── resources
            ├── hazelcast-client.xml
            └── hazelcast.xml               #(5)

1. This file

2. JVM properties, Hazelcast version configs

3. Gradle wrapper

4. Entry point of your Hazelcast application

5. Hazelcast server configuration file

Run your Hazelcast application

./gradlew run #(1)

1. This will use Starter.java to start your Hazelcast application. This can be changed in build.gradle. Look for mainClassName property.

Produce UberJar

./gradlew shadowJar #(1)

1. This command will produce executable jar with Starter.class as Main-Class. This can be changed in build.gradle. Look for mainClassName property.

Start Hazelcast Member Node

To start Hazelcast member node. By default, a member will use hazelcast.xml from src/main/resources folder.

Gradle

./gradlew execute -PmainClass=com.hazelcast.core.server.StartServer