biocache-hubs is a Grails plugin that provides the core functionality for the Atlas of Living Australia (ALA) Occurrence search portal (Biocache) front-end.

This application/plugin provides a web UI for a back-end service called biocache-service (see biocache-service API) - a full-text search and record retreival for occurrence data records, using JSON data format.

An example Grails application that uses this plugin, is the generic-hub app. There are other implementations listed in the ALA Github repository (all implementations have a suffix '-hub').

The easiest way to get started is to clone the generic-hub project and then modify it to suit your needs. Any functionality that you wish to alter, is achieved by creating a copy of the groovy/GSP/JS/CSS/i18n file of interest, from biocache-hubs and placing it in your client app, so that it overrides the plugin version.

E.g. to change the header and footer, create a copy of the file grails-app/views/layout/generic.gsp (calling it acme.gsp) and then edit the configuration file to point to this new GSP file: grails-app/conf/Config.groovy - change skin.layout = 'generic' to the new layout file, e.g. skin.layout = 'acme'.

To load and view you own occurrence record data, you'll need to install and run biocache-store and biocache-service and then configure your app to use your local biocache-service by adding/editing the line: biocache.baseUrl = "http:https://hostname.acme.org/biocache-service/".

A full list of the configuration settings (and their default values) are found in src/main/groovy/au/org/ala/biocache/hubs/defaultConfig.groovy.