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.
- Chia Blockchain
- Climate Tokenization Engine
- Climate Tokenization Engine UI
- Climate Explorer
- Chia Climate Tokenization
- Climate Wallet
- Climate Action Data Trust
- Climate Action Data Trust UI
Precompiled x86 binaries and installers are available for MacOS, Windows, and Debian-based Linux distros (Ubuntu, Mint, PopOS, etc) on the releases page.
The Climate Explorer UI can be installed with apt
.
- Start by updating apt and allowing repository download over HTTPS:
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg
- 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
- 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
- Install the Climate Explorer UI
sudo apt-get update
sudo apt-get install climate-explorer-ui
- Run the Climate Explorer UI from your OS launcher or at the command line with
climate-explorer-ui
.
Install Node 16 and then run the following:
git clone git@github.com:Chia-Network/climate-explorer-ui
cd climate-explorer-ui
npm install foreman -g
npm install
npm run start
You'll need:
- Git
- nvm
This app uses nvm
to align node versions across development, CI and production. If you're working on Windows you should consider nvm-windows
Use the following commands to prepare you development environment and run the Climate Explorer UI:
npm install -g react-scripts
git clone git@github.com:Chia-Network/climate-explorer-ui
cd climate-explorer-ui
nvm install 18.16.0
nvm use 18.16.0
npm install foreman -g
npm install -g husky
npm install -g prettier
npm install -g lint-staged
npm install -g git-authors-cli
npm set-script prepare "husky install"
npm run prepare
// If you are on linux or mac run
chmod ug+x .husky/*
chmod ug+x .git/hooks/*
npm run start
Upon your first commit, you will automatically be added to the package.json file as a contributor.
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 featurefix
is for bug fixesdocs
for documentation only changesstyle
is for code formatting onlyrefactor
is for changes to code which should not be detectable by users or testersperf
is for a code change that improves performancetest
is for changes which only touch test files or related toolingbuild
is for changes which only touch our develop/release toolsci
is for changes to the continuous integration files and scriptschore
is for changes that don't modify code, like a version bumprevert
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.
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.
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.