https://github.com/geoscienceaustralia/geo-web-toolkit
Javascript web mapping toolkit built on AngularJS/Bootstrap
https://github.com/geoscienceaustralia/geo-web-toolkit
Last synced: over 1 year ago
JSON representation
Javascript web mapping toolkit built on AngularJS/Bootstrap
- Host: GitHub
- URL: https://github.com/geoscienceaustralia/geo-web-toolkit
- Owner: GeoscienceAustralia
- License: bsd-3-clause
- Created: 2014-05-30T01:26:46.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2018-03-22T02:26:42.000Z (over 8 years ago)
- Last Synced: 2025-03-17T09:11:25.575Z (over 1 year ago)
- Language: JavaScript
- Size: 11.1 MB
- Stars: 6
- Watchers: 44
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Geo Web Toolkit [](https://travis-ci.org/GeoscienceAustralia/geo-web-toolkit) [](https://coveralls.io/r/GeoscienceAustralia/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`](http://www.graphviz.org/) 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](http://geoscienceaustralia.github.io/geo-web-toolkit/docs/).
[JSFiddle showing a simple example](https://jsfiddle.net/ky7nkr9s/7/).
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.