Home

What is this plugin?

This project aims to be a easy-to-use all-rounded tool for easily bootstrapping your vert.x projects, utilising the Gradle build automation platform.

Features

• Write your entire vert.x (2.0.0-SNAPSHOT) project under the same build script using subprojects
• Write runnable, nonrunnable modules, or just POJLibraries, and let them live under the same roof
• Pre-configured Maven for easier deployment
• Automatically download and explode vert.x module-zips appropriately, and sets up all classpaths appropriately to enable easy building
• easily import entire project into Eclipse using Eclipse Gradle Tooling!

Tested On

• Mac OS X Mountain Lion
• Gradle 1.5 (although it should support > 1.3, but not tested)
• Eclipse Juno with Gradle Tooling

Untested

• Windows or Linux/Unix distros
• IntelliJ

Planned

• improvements to maven support (such as specifying custom repositories)
• bootstrap projects with templating
• easier testing across languages

Known Issues

• exploded zips do not unzip to the correct mod directory

Quickstart

To start off, simply put the following lines in your root build.gradle:

// path/to/root/project/build.gradle
import com.darylteo.gradle.vertx.VertxPlugin

buildscript {
  repositories {
    mavenCentral()
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots' } // for vertx core
  }

  dependencies {
    classpath 'com.darylteo:vertx-gradle-plugin:1.0.0-ALPHA2'
  }
}

apply plugin: VertxPlugin

That's it! Your build is now using the Vertx Gradle Plugin. All you have to do now is setup and configure your projects, then run the tasks!

What do I need to know?

Firstly, you should be familiar with using Gradle. This tends to be the hardest part for most people... this plugin tries to make some things simpler for the common use case, but proficiency with Gradle can enable you to push your builds to the limit.

Next, you should download and install Gradle on your computer if you haven't already.

Examples

• Edge Framework demonstrates a project consisting of multiple Modules.
• RxJava Promises demonstrates a project with vert.x Modules as well as POJLibraries.
• Coming Soon: a complete vert.x web application

Credits

This project is forked from purplefox's vertx-gradle-template.