search

apigovau / api-gov-au

MIT License
25 stars 5 forks source link

readme

api.gov.au

Makes it easier to discover electronic government services

Current Status

api.gov.au is under development. It is currently at the beta stage, a live version can be viewed at https://api.gov.au/

Technology

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

Running Locally

You will need an instance of PostgreSQL running, for example here is how to run one with Docker:

# Clone git repo
git clone https://github.com/apigovau/api-gov-au.git
cd api-gov-au/

# Build it
gradle build

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

# Run it
SPRING_PROFILES_ACTIVE=notprodordefault \
SPRING_DATASOURCE_URL="jdbc:postgresql://localhost:5432/postgres?user=postgres&password=mysecretpassword" \
BaseRepoURI=https://service-catalogue-repository.herokuapp.com/ \
    java -Xmx200m -Xss512k -jar build/libs/service-catalogue-1.0.jar

Your app should now be running on localhost:5000.

Deploying to CloudFoundry

cf push

Documentation

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

Reusing government tools

The prototype also uses the Australian Government Design System. 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.