In this guide we'll show you how to develop a Vert.x project using Gradle.
We provide a template Gradle project which you can clone to get you started.
Clone it locally
git clone https://github.com/vert-x/vertx-gradle-template.git my-vertx-module
my-vertx-module is the name you want to give your project.
Remove the origin
git remote rm origin
And add your new origin
git remote add origin <path to your repo>
Let's run the tests to make sure everything is working
cd my-vertx-module ./gradlew test
You should use the Gradle Wrapper (
./gradlew) to run all Gradle tasks. You do not need to install Gradle manually. Take a look at
build.gradle for a list of the available tasks.
The outputs of the project are:
The outputs are created in the
build directory as per normal.
You configure many things in
version determine the name of the module as described in the modules manual
pullInDeps determines whether all module dependencies should be packaged into the module as nested modules.
It also contains various properties used to configure versions of various dependencies.
If you want to override any Vert.x platform configuration, e.g.
cluster.xml or logging configuration, you can add those files to the directory
src/main/platform_lib - these will then be added to the Vert.x platform classpath when you run the module with
build.gradle and take a look at the comments there for a list of useful tasks supported by the build script.
You can use the
eclipse Gradle plugins to create the project files for your IDE
Once the IDE files have been created you can open the project files in your IDE.
Note: You can run the
eclipse tasks again if you change your project dependencies - in this way the IDE project files will be brought up-to-date.
You may have to tell your IDE to use Java source compatibility level of Java 7, as Gradle seems to default to Java 6 (!)
If your project needs a third party jar to build and you want to include it in the
lib directory of your module you can add the dependency in the
dependencies section of
build.gradle with a type of
If you don't want it to be included in the
lib directory you should add it as
Once you've changed your dependencies just run
./gradlew idea or
./gradlew eclipse again to update your IDE project files with the new dependencies.
./gradlew install to install your module in your local Maven repository.
./gradlew uploadArchives as normal to push your module to a Maven repository.
If you've pushed your module to a public Maven or Bintray repository you can register it in the Module Registry so others can search for and discover it.
Now you've got the project all set-up and running, it's time to explore the standard project layout itself.