https://github.com/vert-x3/vertx-gradle-starter

Gradle project template for Vert.x
https://github.com/vert-x3/vertx-gradle-starter

gradle starter template vertx

Last synced: 3 months ago
JSON representation

Gradle project template for Vert.x

• Host: GitHub
• URL: https://github.com/vert-x3/vertx-gradle-starter
• Owner: vert-x3
• Created: 2016-10-11T08:55:55.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-15T14:08:19.000Z (about 4 years ago)
• Last Synced: 2024-09-29T13:43:02.982Z (3 months ago)
• Topics: gradle, starter, template, vertx
• Language: Java
• Homepage: https://start.vertx.io
• Size: 212 KB
• Stars: 89
• Watchers: 31
• Forks: 34
• Open Issues: 2
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
= Vert.x Gradle Starter

This project is a template to start your own Vert.x project using Gradle.

== Prerequisites

* JDK 8+

== Getting started

Create your project with:

[source]

----

git clone https://github.com/vert-x3/vertx-gradle-starter.git PROJECT_NAME

----

Replace `PROJECT_NAME` with the name of your project.

On Linux and MacOSx (or Windows with `bash`), if you want to go faster and generate an already configured project run:

[source]

----

curl http://vertx.io/assets/starter-scripts/create-vertx-project-gradle.sh -o vertx-create-gradle-project.sh; bash vertx-create-gradle-project.sh

----

== Running the project

Once you have retrieved the project, you can check that everything works with:

[source]

----

./gradlew test run

----

The command compiles the project and runs the tests, then  it launches the application, so you can check by yourself. Open your browser to http://localhost:8080. You should see a _Hello World_ message.

== Anatomy of the project

The project contains:

* the Gradle project using the Kotlin DSL (see `build.gradle.kts`) with auto-reloading and fat-jar building

* a _main_ verticle file (`src/main/java/io/vertx/starter/MainVerticle.java`)

* a unit test (`src/main/test/io/vertx/starter/MainVerticleTest.java`)

== Start to hack

1. Delete the `.git` directory

2. Open the `build.gradle.kts` file and customize `vertxVersion`. You can also change the `mainVerticleName` variable to use your own package name and verticle class.

3. Run `./gradlew run`.

This last command relaunches Gradle and the application as soon as you change something under `src/main`.

== Building the project

To build the project, just use:

----

./gradlew build

----

It generates a _fat-jar_ in the `build/libs` directory.