Geo Web Toolkit

Geoscience Australia's web mapping toolkit.

Contains AngularJS-based modules to support rapid development of web mapping applications.

Available via bower install geo-web-toolkit.

Requirements

Required:

• Java 1.6+
• Maven 3+

Recommended:

• NodeJS^

^a local copy is installed as part of the Maven build, but a global install will make it easier to quickly run the JS unit tests locally.

Building

The toolkit can be built using Maven

>> mvn clean install

Or can be built without the need for Java using Grunt using grunt build.

Angular dependency graph can be generated using grunt angular_architecture_graph but does required graphviz to be installed. The output of this can be found in the /architecture folder. This generates an overview module graph as well as detailed component level diagrams for all internal modules.

Documentation

Maven build generates ngdocs in the docs directory.

Generated docs are available.

JSFiddle showing a simple example.

These docs are also generated by using the default grunt task.

Running tests locally

Make sure all NPM dependencies are installed.

npm install

Make sure all Bower dependencies are installed.

bower install

Then the Karma runner can be launched using the following (assuming you have installed Karma globally as described at http://karma-runner.github.io/0.12/intro/installation.html)

>> karma start src/test/js/config/karma.conf.js

Tests can be executed by using grunt karma

Name change for directives

As of bower version 0.20.x onwards, directives will use the geo- prefix as opposed to the old ga- prefix. This is to make the names more meaningful as well as make them less Geoscience Australia centric.