Skip to content

Customisation

dxb edited this page May 31, 2023 · 2 revisions

How to customize NGC for you needs?

To sum up, there is two possibilities to achieve this:

  1. To fork the nosgestesclimat-site repository. You will have full control of the content and modifications, however, you need to anticipate a consequent amount of effort and development time to maintain it -- ~several weeks of web development.

  2. To integrate the custom iframe. You will have less control but it should take only ~15 minutes for a tech-user to achieve thisl

Fork

The code source of the website is open-source under the MIT license: you are free to reuse the content of this repository as long as you credit the source. For example you can add this paragraph on your home page:

"This version is freely based on the official version of Nos Gestes Climat developed by ADEME and ABC."

Important, If you decide to fork the project, you need to remove any reference to the brand Nos Gestes Climat as well as form contact and bug report targeting our domains. Indeed, nosgestesclimat.fr is actively developed, we cannot afford that citizens have access to several desynchronized versions of the tool, both in terms of climate footprint model and user interface.

Unless explicitly agreed, the logos ADEME, ABC, Nos Gestes Climat, must be removed by your care in your own version.

Custom iframe integration

The main advantage of this method is to avoid a regular maintenance as it automatically receives updates from the platform, without any effort. Moreover, this allows to keep the NGC brand.

To proceed, you simply need to add the snippet of code in your project:

<script
    id="nosgestesclimat"
    src="https://nosgestesclimat.fr/iframe.js"
></script>

You can check the online demo and the corresponding HTML page.

Collect data from the simulation

By simply adding the parameter data-share-data=true to the HTML script, a message will be displayed to the user when he/she arrives on the end of simulation screen asking him/her if he/she wants to share his/her end of simulation data (only the footprint of the main consumption categories will be shared: food, transport etc.) to the website hosting the iframe.

On your side, here is an example of how to use this feature. You will have to code (a little).

Important, although we offer you this possibility, the responsibility of data processing is entirely on your side. According to the RGPD law, you must inform the user beforehand of the use that will be made of his data.