Skip to content

Open-Earth-Foundation/co2-pricing

Repository files navigation

CO2 Pricing

This repository contains components used to offer an open source CO2 pricing tool. The tool is based on the work of the Climate Framework for Uncertainty, Negotiation and Distribution (FUND). It provides a simple way to estimate the impact of CO2 pricing on the economy and the environment. It also includes 2 other solutions in it:

Image

Built With

Getting Started

This repository is a monorepo, so you can run it in different ways,

Developing with docker-compose (Recommended)

The easiest way is to use the docker-compose file provided in the root of the repository. It will build the web application and the API Wrapper, and run them in a docker container.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Docker
  • docker-compose (should be installed with Docker)

Installation

  1. Clone the repo

    git clone https://github.com/Open-Earth-Foundation/co2-pricing.git
  2. Copy the apps/web/.env.example file to apps/web/.env and fill the variables

    cp apps/web/.env.example apps/web/.env
  3. Run the docker-compose file

     docker-compose up

Roadmap

See the open issues for a full list of proposed features (and known issues).

Design Choices

License

Distributed under the MIT License. See LICENSE.txt for more information.