Energy Security Safeguard - Rule Dashboard

This is the frontend application for the Energy Security Safeguard "Rules Dashboard".

Functionality:

• Presents the contents of the "openfisca_nsw_safeguard" OpenFisca ruleset in a graphical frontend web application.
• Displays relationships between OpenFisca Variables. This includes the ability to compare Variables.
• Performs calculations on OpenFisca Variables.

Application stack

• The "Rule Dashboard" repo assumes the above application stack.
• The stack comprises of the 'OpenFisca-Core API' and the 'Django API'

To serve locally:

Ensure you have installed the necessary requirements on your machine

Installation process may differ on Windows/Mac/Linux. If unsure, Google the steps for your operating systems.

• Node.JS and NPM (https://www.npmjs.com/get-npm)
• Yarn (https://classic.yarnpkg.com/en/docs/install/#debian-stable)

Launch the app locally

In the project directory, you can run:

# Copy the .env.example, and set the variable correctly
cp .env.example .env

# Use NVM if available, otherwise make sure npm is version 14
nvm use
# Do not attempt to use npm, there is issue with the incompatibility packages
# That requires specific on node 14 + yarn
npm i -g yarn
yarn install

yarn run start

# Open the http://localhost:3000