rayokota / generator-aurelia-dropwizard

Yeoman generator for Aurelia + Dropwizard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Aurelia-Dropwizard generator

A Yeoman generator for Aurelia and Dropwizard.

Installation

Install Git, node.js, JDK 7, and Maven 3.

Install Gulp and jspm:

npm install -g gulp

npm install -g jspm

Install Yeoman:

npm install -g yo

Install the Aurelia-Dropwizard generator:

npm install -g generator-aurelia-dropwizard

Creating a Dropwizard service

In a new directory, generate the service:

yo aurelia-dropwizard

Compile the service:

mvn compile && gulp build

Run the service:

mvn exec:exec -pl [myapp]-service

Your service will run at http://localhost:8080. It's time to create some resources.

Creating a resource class

Generate the resource:

yo aurelia-dropwizard:resource [myresource]

You will be asked to specify methods for the resource, where each method has the following:

  • a name
  • a type (GET, POST, PUT, DELETE, HEAD)
  • a URI path template, such as /users/{userId}/orders/{orderId}
  • for a POST method, an optional list of form parameters

Files that are regenerated will appear as conflicts. Allow the generator to overwrite these files as long as no custom changes have been made.

Compile and rerun the service:

mvn compile && gulp build

mvn exec:exec -pl [myapp]-service

You can now invoke HTTP requests against your service, such as

curl -X POST localhost:8080/myapp/myresource/users/1/orders/2 \
	 -d "formParam1=hello&formParam2=world"

Creating a persistent entity

Generate the entity:

yo aurelia-dropwizard:entity [myentity]

You will be asked to specify attributes for the entity, where each attribute has the following:

  • a name
  • a type (String, Integer, Long, Float, Double, Boolean, Date, Enum)
  • for a String attribute, an optional minimum and maximum length
  • for a numeric attribute, an optional minimum and maximum value
  • for a Date attribute, an optional constraint to either past values or future values
  • for an Enum attribute, a list of enumerated values
  • whether the attribute is required

Compile and rerun the service:

mvn compile && gulp build

mvn exec:exec -pl [myapp]-service

A client-side Aurelia application will now be available by running

gulp watch

The Gulp server will run at http://localhost:9000. It will proxy REST requests to the Dropwizard service running at http://localhost:8080.

At this point you should be able to navigate to a page to manage your persistent entities.

The Gulp server supports hot reloading of client-side HTML/CSS/Javascript file changes, while the Dropwizard service supports hot reloading of Java class file changes.

About

Yeoman generator for Aurelia + Dropwizard

License:MIT License


Languages

Language:JavaScript 66.7%Language:Java 21.1%Language:HTML 11.7%Language:CSS 0.5%