This repository has merged into api-gov-au

Data definitions catalogue

Making it easy to discover what data is collected, held or used by government, no matter who defines it, how it is defined, or where it is defined.

Technology

This service uses Kotlin, Spring Boot and is deployed to Heroku.

For a basic introduction to Kotlin, Spring Boot and Heroku, read the Getting Started with Kotlin on Heroku article.

Running Locally

# Get the source
git clone https://github.com/apigovau/api-gov-au-definitions.git
cd api-gov-au-definitions/

# Build it
gradle build

# Create a PostgreSQL instance
docker run --name api-gov-au-definitions-db -p 5433:5432 -e POSTGRES_PASSWORD=mysecretpassword -d postgres:9.6

# Run it
SPRING_PROFILES_ACTIVE=notprodordefault \
SPRING_DATASOURCE_URL="jdbc:postgresql://localhost:5433/postgres?user=postgres&password=mysecretpassword" \
    java -Xmx200m -Xss512k -jar build/libs/definitions-catalogue-1.0.jar

Your app should now be running on localhost:5002/definitions/.

Deploying to CloudFoundry

cf push

Data

This catalogue shows data definitions from the Standard Business Reporting XBRL taxonomy

You will need to extract the definitions from the XBRL files first, using this tool

Documentation

For more information about using Java and Kotlin on Heroku, see these Dev Center articles:

• Java on Heroku

Reusing government tools

The prototype also uses Gov.au UI-Kit. If you want to make any significant changes to the styling, you'll need Node, NPM and Yarn.

Making contributions

To propose a change, you first need to create a GitHub account.

Once you're signed in, you can browse through the folders above and choose the content you're looking for. You should then see the content in Markdown form. Click the Edit icon in the top-right corner to start editing the content.

The content is written in the Markdown format. There's a guide here on how to get started with it.

You can preview your changes using the tabs at the top of the editor.

When you're happy with your change, make sure to create a pull request for it using the options at the bottom of the page. You'll need to write a short description of the changes you've made.

A pull request is a proposal for a change to the content. Other people can comment on the change and make suggestions. When your change has been reviewed, it will be "merged" - and it will appear immediately in the published content.

Take a look at this guide on GitHub about pull requests.