carbonable / carbonable-ccrp-app

Carbonable CCRP

Carbon Contribution Portfolio Manager (CCPM)

The Carbon Contribution Portfolio Manager (CCPM) is a web application that helps companies track their carbon emissions, set targets for reducing emissions, and manage carbon investments. This README.md provides an overview of the project, its technologies, and how to set it up.

Technologies Used

Remix.run: A modern web framework for building fast and dynamic web applications. Apollo Client: A powerful GraphQL client for making API requests. GraphQL: A query language for your API. graphql-codegen: A tool for generating strongly typed code from GraphQL schema and operations. emailjs: A service for sending emails.

Environment Variables

To get the CCPM project up and running, you will need to set up the following environment variables in your .env file:

DATABASE_URL=
SESSION_EXPIRATION_IN_SECONDS=
SESSIONS_SECRETS=
HASH_SECRET=
MAILJS_PUBLIC_KEY=
MAILJS_PRIVATE_KEY=
MAILJS_SERVICE_ID=
MAILJS_TEMPLATE_ID=

GRAPHQL_ENDPOINT=
ENABLE_EMAIL_VERIFICATION=

Generating Types

To generate types for the GraphQL schema, run the following command:

npm run compile

Development

From your terminal:

npm run dev

This starts your app in development mode, rebuilding assets on file changes.

Deployment

1. Install flyctl

2. Sign up and log in to Fly

flyctl auth signup

3. Setup Fly. It might ask if you want to deploy, say no since you haven't built the app yet.

flyctl launch

4. If you've followed the setup instructions already, all you need to do is run this:

fly deploy

You can run flyctl info to get the url and ip address of your server.

Check out the fly docs for more information.

carbonable-ccrp-app's Issues

QA #1 - CCRP MVP - Left to do (team-workshop)

1. Définir les émissions
2. Définir les targets
3. Set up les allocations
4. Tester Orders - Annual (once allocations are made)

QA #1 - CRP MVP - Stock - Annual

1. les années sont dans le désordre
2. Devrait y avoir des Ex-post achetés (le projet braulio)
3. La pagination fonctionne pas => Quand on clique sur 2, cela load puis revient sur la page 1, et idem pour 3 ou 4

QA#1 - CRP MVP - Project Impact

Exemple concret de banegas farm

1. les SDGs ne matchent pas
2. le # de species ne matche pas
3. le nombre de t ne matche pas
4. le nombre d'hectares ne matche pas

Digitize all carbon assets CCRP

Je veux pouvoir numériser l’ensemble de mes actifs de contribution carbone et flaguer mes types d’assets:

Projets financés (flag "forward")
Instant t: Reflètent ma quantité d’ex-posts et ex-ante (année a)
Transformation dans le temps: Reflètent le calendrier de transformation prévisionnel des CC ex-ante en ex-posts au cours du projet

Crédits achetés on spot (flag "spot")
Crédits Ex-posts purchased from outside
Crédits Ex-posts purchased from Carbonable

QA#1 - CRP MVP - PROJECT HEADERS

1. L'allocation ne fonctionne pas... Sur manjarisoa: factuellement, 100 000 units sont alloués et non la totalité.
2. Attention l'allocation est en kg et non en tonnes
3. Sur banegas farm, il devrait y avoir des ex-posts de dispos et là, cela reste à zéro.
4. Certaines images ne loadent pas (e.g. Manjarisoa)

QA #1 - CRP MVP - Stock Cumulative

1. Données manquantes: Cumulative issued / Cumulative emission debt
2. Les années sont dans le désordre
3. Cumulative purchased => projet Braulio devrait être pris en compte
4. Pagination cassée également

QA#1 - CRP MVP - Project Allocation

J'ai alloué 100 t de banegas farm à la Business Unit "Group"

1. rien ne se passe quand je clique sur yes. Mais quand je reload, l'allocation est bien prise en compte.

2. Je vois que l'allocation de 100 est bien prise en compte dans carbon management, mais dans le header rien n'a changé au niveau des available ex-ante.

Modify emissions (Nice to have MVP +) CCRP

Je veux pouvoir changer mes prévisions d’émissions (car elles sont éminemment dynamiques) et que les éléments suivant soient mis à jour:

• Les % d’actuals pour l’année impliquée et pour tout le restant
  => Manuellement hors plateforme par l’équipe Carbonable (soumission des donées via Excel)

Actuals

Je veux pouvoir visualiser mes actuals d’ores et déjà passés (la vraie différence entre mes targets passés vs. mes contributions passées) ou prévisionnels (la différence entre mes targets futurs et mes planifications à date)

Emission forecasts

Je veux numériser mes prévisions d’émissions (MVP)

• Manuellement hors plateforme par l’équipe Carbonable (soumission des données via Excel)

QA#1 - CRP MVP - BU Impact Metrics

Impact metrics broken

Removed tons - not working
Restored hectares - not working
Protected species - not working

Portfolio link from the menu is broken

impossible to access the portfolio from the menu

Graph carbon management projets

Sur les pages projets, au niveau carbon management

=> le graph ne doit pas avoir emissions, ni target, ni actuals (et on doit donc enlever aussi les ordonnées à droite)

Baseline Calculator - Integrate in CCRP

Description

As Carbonable I should be able to Integrate Baseline calculator in CCRP after performing the pr-requisite task of : taking source code of what was done during hackathon and giving it a feel of our other applications,

Acceptance Criteria

• Integrate baseline calculator in CCRP

QA#1 - CRP - MVP - Rajouter Rating dans le template et les projets individuels

Rating est une info dans le header des projets qui n'est pour l'instant pas dans le template projet

• à rajouter dans la checklist github

=> pour moi
=> pour Arnaud

• notifier valentin lorsque les projets individuels ont eu les notes ajoutées (pour loader les bonnes)

QA #1 - CCRP MVP - Netz Zero Planning Bugs

• 1. La courbe "fait n'importe quoi"
• 2. Manque les années en abscisse
• 3. Le hover ne fonctionne pas

Create a business unit

Hover info not correct - let's add a couple of indicators

CO2 contributions are wrong

Hover information should be

• Carbon Emissions
• Credits Retired (I.e. the qty of credits consumed this very year)
• Net Zero target (%)
• Actuals (%)

QA#1 - CRP MVP - BU Project Metrics

Project metrics are broken:

Color should be green 100%
Project standard should be Verra 100%
Madagascar should be 100%

QA#1 - CRP MVP - BUSINESS UNIT CREATION

1. Bizare de demander le nbre d'émissions et target, sachant que ce sera un calendrier d'émissions à remplir in fine.
2. Où apparait la description? Si nulle part, alors enlever du formulaire
3. Pas vraiment compréhensible les "key metadata"
4. Problème dans le header: le # de projets devrait refleter le nomber de projets qui lui sont associés (ici Zéro)
5. Double titre Projected decarbonation vs. Net Zero Planning

QA#1 - CRP MVP - Business Unit Allocation

I allocated 100,000 units on Manjarisoa
=> nothing happened when saying yes.

Had to go back and reload to get values.

Project page update

Je veux le détail des informations sur chaque projet

• Description
• Monitoring Banegas
• Carbon management (Nice to have MVP +)

I allocated 100% of banegas farm and it broke everything

Targets went back to zero
The actuals graph makes no sense

The Banegas Farm units retired are not taken into account in the Stock annual or cumulative

The financial analysis table is "empty" (only 2055)

Link to impact reports

Je veux des rapports d”impact

• à l’échelle du groupe
• à l’echelle des business units
• à l’échelle des projets

(Lien vers Impactr pour le moment)

QA#1 - CRP MVP - Impact Reports link

None of the impact reports link is working.
Neither at the business unit level
Nor at the menu level
Nor at the project level

Note to myself => list of relevant links to provide

Contribution targets

Je veux pouvoir insérer des targets de compensation en % années après année

• Manuellement hors plateforme par l’équipe Carbonable (soumission des donées via Excel) pour le MVP

CCRP MVP wrap up

Description

Graph

• Add retired column
• Add zoom librairy

Business unit allocations

• Add Carbonable icon on the card

Reporting

• Get new image without Bel from Guillaume

Portfolio

• Get new map from Guillaume

Project page

• Harmonize the header
• Add retired column on chart

Menu

• Calculator et Impact Report in i-frame

Financial Analysis

• Waiting for MVP from Guillaume

Overall

• Units in all tables headers
• Actual in percentage like target

QA#1 - CRP MVP - Reporting (dashboard)

1. SDGs broken (should only but a list of all applicable project SDGs)

2. t an hectares semblent être inversés

3. => nous devons nous accordé sur la manière de calculer les KPIs:

• a. tous projets confondus?
• b. la totalité de ceux alloués?
• c. ou seuls ceux vraiment planifiés pour offset?

à discuter ensemble

QA#1 - CRP MVP - Financial Analysis

Average issued Price remains TBD

Update dashboards with new API