User interface for the Core Registry API. Combines Core Registry CADT UI, Climate Tokenization Engine UI, and Climate Explorer UI into a single interface.
The UI application can be hosted as a web application and accessed via the browser, or as a desktop application packaged with Electron. Currently the application is only packaged for x86 platforms, though building from source is expected to work on ARM.
The releases page provides desktop applications packaged for Windows, Mac, and Debian-based Linux distributions.
The Core Registry 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 Core Registry API. This means the API must be available on the public internet if the UI is public. Always set an API key to prevent unauthorized access.
To host the UI on the web, use the 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.
Upon your first commit, you will automatically be added to the package.json file as a contributor.
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.
featis for introducing a new featurefixis for bug fixesdocsfor documentation only changesstyleis for code formatting onlyrefactoris for changes to code which should not be detectable by users or testerstestis for changes which only touch test files or related toolingbuildis for changes which only touch our develop/release toolschoreis for housekeeping tasks such as hydrating from another branch
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 main.