h3rucutu/caltic-vertx-starter

Vert.x Project Starter

Caltic Vert.x Starter

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

Build Status

• master

• develop

Prerequisites

• Apache Maven

• JDK 8+

Getting started

Create your project with:

git clone https://github.com/h3rucutu/caltic-vertx-starter.git `PROJECT_NAME`

Replace PROJECT_NAME with the name of your project.

Running the project

Once you have retrieved the project, enter into your project then you can check that everything works with:

./mvnw clean compile vertx:run

On Windows:

mvnw.cmd clean compile vertx:run

The command compiles the project and run it in redeploy mode. Open your browser to http://localhost:9000. You should see a Hello Caltic Vert.x! message.

Redeploy mode helps developer to compile immediately when there’s a changes and deploy it automatically, usually called hot-reload.

Besides run in redeploy mode, you also can package into one jar file:

./mvnw clean compile vertx:package

On Windows:

mvnw.cmd clean compile vertx:package

And run it with java -jar command:

java -jar target/*jar

Anatomy of the project

The project contains:

• a pom.xml file

• a main verticle file (MainVerticle.java)

• an unit test (MainVerticleTest.java)

Start to hack

1. Delete the .git directory:

2. Open the pom.xml file and customize the groupId, artifactId and version. You can also change the main.verticle property to use your own package name and verticle class.

3. After editing pom.xml file, change necessary directory under src/main/java and src/test/java following your groupId.

4. Save all your work and try to run.

Git-Flow

This project is maintained using git-flow. Please refer git-flow website for the instructions.

Caltic.id

This project brought to you by caltic.id