Skip to content

Energy Charts is a React App created for exploring and disseminating energy scenarios

License

Notifications You must be signed in to change notification settings

facilitate-energy/energy-charts

Repository files navigation

Energy Charts

license Netlify Status

This project was bootstrapped with Create React App and migrated to Vite.

Purpose

Energy Charts is a web application developed to:

  • make it easier to communicate energy modelling results and scenarios to stakeholders;
  • facilitate discussion of energy modelling results and make model debugging easier;
  • disseminate energy modelling results and scenarios to a wide audience.

To run locally

After cloning from GitHub, execute from within the repository:

npm install

Followed by:

npm start

Requires Node.js.

To deploy

Follow this guide to deploy on Netlify.

To customise

  • Scenario data is located in public/data
  • Mardown files to be rendered as Pages are in public/pages
  • Routes and other configuration settings are in src/config.js
  • Charts' specs are in src/specs/chartsInfo.js. These also act as filters.

To use as dependency

To use Energy Charts as dependency in a project run:

npm install energy-charts --save-prod

License

Copyright 2021-2024 Facilitate Energy Ltd.

Energy Charts is licensed under the Apache License, Version 2.0.

You may obtain a copy of the License here or at http://www.apache.org/licenses/LICENSE-2.0.