Skip to content

Latest commit

 

History

History
185 lines (129 loc) · 7.24 KB

README.md

File metadata and controls

185 lines (129 loc) · 7.24 KB
Raw

Climate Explorer User Interface

The Climate Explorer User Interface is the best way for a registry or watchdog organization to follow all on-chain activity related to the tokenization of carbon credits using the Climate Tokenization Engine. This user interface accesses data from the Climate Explorer and displays all Tokenization, Detokenization, and Retirement events for carbon tokens issued by a particular registry.

The Climate Explorer UI is the final piece of the Climate Tokenization Suite to provide full transparency into the tokenization process.

Registries leveraging the Climate Tokenization Engine should plan on setting up a separate machine to run the Climate Explorer and UI, as the Climate Explorer is meant to publicly surface registry token activity that is occurring on the Chia blockchain. By having a separate machine running the Climate Explorer, organizations are able to better protect the CADT, Climate Tokenization Engine, & Chia Climate Tokenization services while still providing transparency to their constituents.

Related Projects

QuickStart

Installation

Precompiled x86 binaries and installers are available for MacOS, Windows, and Debian-based Linux distros (Ubuntu, Mint, PopOS, etc) on the releases page.

Using APT on Debian-based Linux Distros (Ubuntu, Mint, etc)

The Climate Explorer UI can be installed with apt.

  1. Start by updating apt and allowing repository download over HTTPS:
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
  1. Add Chia's official GPG Key (if you have installed Chia with apt, you'll have this key already and will get a message about overwriting the existing key, which is safe to do):
curl -sL https://repo.chia.net/FD39E6D3.pubkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/chia.gpg
  1. Use the following command to setup the repository.
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/chia.gpg] https://repo.chia.net/climate-tokenization/debian/ stable main" | sudo tee /etc/apt/sources.list.d/climate-tokenization.list > /dev/null
  1. Install the Climate Explorer UI
sudo apt-get update
sudo apt-get install climate-explorer-ui
  1. Run the Climate Explorer UI from your OS launcher or at the command line with climate-explorer-ui.

Web Application

The Explorer UI can be hosted as a web application, either for internal use, or made available to the public. When operating as a web application, the user's browser must be able to connect to the Climate Token Driver running in Explorer mode. This means the API must be available on the public internet if the UI is public.

To host the UI on the web, use the climate-explorer-ui-web-build.tar.gz file from the releases page. One of the simplest solutions is to uncompress these files into a public S3 bucket. These files could also be served by any webserver, such as Nginx or Apache.

Sample Nginx Config

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    # Path on disk to Explorer UI files
    root /var/www/explorer-ui/build;

    # Domain name where this site will be served from
    server_name explorer-ui-example-config.com;

    # SSL certificates with full path
    ssl_certificate /path/to/ssl/certificate/fullchain.pem;
    ssl_certificate_key /path/to/ssl/certificate/privkey.pem;

    # Optional, but recommended
    resolver                  1.1.1.1;

    try_files $uri /index.html;
}

Installing from Source

Install Node 20 and then run the following:

git clone git@github.com:Chia-Network/climate-explorer-ui
cd climate-explorer-ui
npm install
npm run start

Developer Guide

Prerequisites

You'll need:

This app uses nvm to align node versions across development, CI and production. If you're working on Windows you should consider nvm-windows

Development Environment

Use the following commands to prepare you development environment and run the Climate Explorer UI:

git clone git@github.com:Chia-Network/climate-explorer-ui
cd climate-explorer-ui
nvm install
nvm use
npm install -g husky
npm install -g prettier
npm install -g lint-staged
npm install -g git-authors-cli

npm run start

Contributing

Upon your first commit, you will automatically be added to the package.json file as a contributor.

Commiting

Signed commits are required.

This repo uses a commit convention. A typical commit message might read:

    fix: correct home screen layout

The first part of this is the commit "type". The most common types are "feat" for new features, and "fix" for bugfixes. Using these commit types helps us correctly manage our version numbers and changelogs. Since our release process calculates new version numbers from our commits it is very important to get this right.

  • feat is for introducing a new feature
  • fix is for bug fixes
  • docs for documentation only changes
  • style is for code formatting only
  • refactor is for changes to code which should not be detectable by users or testers
  • perf is for a code change that improves performance
  • test is for changes which only touch test files or related tooling
  • build is for changes which only touch our develop/release tools
  • ci is for changes to the continuous integration files and scripts
  • chore is for changes that don't modify code, like a version bump
  • revert is for reverting a previous commit

After the type and scope there should be a colon.

The "subject" of the commit follows. It should be a short indication of the change. The commit convention prefers that this is written in the present-imperative tense.

Commit linting

Each time you commit the message will be checked against these standards in a pre-commit hook. Additionally all the commits in a PR branch will be linted before it can be merged to master.

Branch Layout

All pull requests should be made against the develop branch. Commits to the main branch will trigger a release, so the main branch is always the code in the latest release.