README.md

Getting Started

Requirements

Required Software

• Docker

Required Credentials

Create API keys for each of these services. You may need to create an account and log in

• Stats NZ API Key (For fetching SA1 data)
• Cesium access token (API token to retrieve map data from Cesium)

Starting the services

1. Clone this repository to your local machine.

2. Create a file called .env in the project root, copy the contents of .env.template and fill in all blank fields unless a comment says you can leave it blank. Blank fields to fill in include things like the POSTGRES_PASSWORD variable and CESIUM_ACCESS_TOKEN. You may configure other variables as needed.

3. Add the data file as initialise_db/data/revised_BRANZ_SA1_emissions.xlsx

4. From project root, run the command docker-compose up --build -d to run the database, webservers, and initialisation script.

5. You may inspect the logs of the initialisation script using docker-compose logs -f initialise_db

6. Visit http://localhost:{WWW_PORT} to view the site. (values from .env, defaults to 8080)