search

energywebfoundation / origin

Origin is a set of toolkits that together provide a system for issuance and management of Energy Attribute Certificates
https://energyweb.org/technology/ew-origin/
MIT License
104 stars 57 forks source link

readme


EnergyWeb
EnergyWeb Origin

Origin is a set of toolkits that together provide a system for issuance and management of Energy Attribute Certificates (EACs). This repository is an entry point to Origin systems. It has a goal of explaining briefly the whole system and providing you with insight and info where to explore next.

:construction: Documentation available at https://energy-web-foundation-origin.readthedocs-hosted.com/en/latest/ :construction:

Table of Contents

Packages

SDK Releases

Package Stable Canary Description
@energyweb/origin-device-registry-api npm npm Generic implementation of API working with Origin device registry
@energyweb/origin-device-registry-irec-local-api npm npm API for local version of I-REC compatible registry
@energyweb/origin-energy-api npm npm API for Smart meter reads
@energyweb/origin-organization-irec-api npm npm API for I-REC based organizations
@energyweb/origin-backend npm npm Example backend necessary for running Origin
@energyweb/issuer npm npm Energy Attribute Certificates Issuer Module
@energyweb/issuer-api npm npm NestJS module for interacting with renewable energy certificates
@energyweb/issuer-irec-api npm npm NestJS module for interacting with renewable energy certificates with IREC connectivity
@energyweb/exchange npm npm A service project hosting order book based exchange
@energyweb/exchange-irec npm npm A service project hosting order book based I-REC specific exchange
@energyweb/exchange-core npm npm Generic EACs order book product and matching
@energyweb/exchange-core-irec npm npm An IREC based EACs product and matching
@energyweb/exchange-io-erc1888 npm npm ERC1888 withdwaral/deposit processing for exchange
@energyweb/utils-general npm npm General Utilities
@energyweb/origin-ui-core npm npm React components library for building Origin marketplace user interface
@energyweb/origin-ui-localization npm npm Localization library for building Origin marketplace user interface
@energyweb/origin-ui-theme npm npm Material-UI theme configuration and styling utilities
@energyweb/origin-ui-utils npm npm UI general utilities

Applications, Infrastructure and Demo

Package Description
@energyweb/origin-backend-irec-app Bootstrap project for Origin API that uses I-REC API connection
@energyweb/origin-ui Root of UI for Origin
@energyweb/migrations-irec Deployment and configuration utilities

Packages types

Origin monorepo produce 3 types of the packages that are meant to be used in different use-cases:

Stable

Stable Origin SDK packages are created during release branch build.

Install using yarn add @energyweb/{package}

Canary

Canary packages are created during master branch builds. Canary reflects current state of the master branch, they should be a working versions considers as alpha

Install using yarn add @energyweb/{package}@canary

Preview

Preview packages are built on a special preview branch, this is mostly used as interal tool for tests, demos, discussions.

Install using yarn add @energyweb/{package}@preview

Preparation

  1. Make sure you are using Node 14.x.x
  2. Make sure have latest @microsoft/rush package manager installed.
npm install -g @microsoft/rush
  1. Make sure you have Java runtime installed
  2. Install Postgres 12.x+ and create a new database named origin.

We recommend using Docker based setup as follows (requires psql command line tool installed):

docker pull postgres
docker run --name origin-postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=origin -d -p 5432:5432 postgres

  1. Make sure you have created a .env file in the root of the monorepo and that all necessary variables are set. Use .env.example as an example of how the .env file should look.

  2. Create InfluxDB to store smart meter readings

docker run --rm --env-file ./.env -v $PWD/influxdb-local:/var/lib/influxdb influxdb:1.8 /init-influxdb.sh

Run the InfluxDB instance

docker run --name energy-influxdb --env-file ./.env -d -p 8086:8086 -v $PWD/influxdb-local:/var/lib/influxdb -v $PWD/influxdb.conf:/etc/influxdb/influxdb.conf:ro influxdb:1.8
  1. For custom DB credentials, ports, db name etc refer to https://github.com/energywebfoundation/origin/tree/master/packages/apps/origin-backend-irec-app#development

Installation

rush update

Build

rush build

Test

rush test:e2e

Run demo

After you have the .env file created, installed dependencies (rush install) and build completed (rush build) run the following command:

rush run:origin

Visit the UI at: http://localhost:3000.

Heroku environment provisioning

For fast deployment to Heroku you can run the available script provision-heroku-origin

PREFIX=<name> STAGE=<stage> TEAM=<team> ./provision-heroku-origin.sh

Naming convention is for apps:

${PREFIX}-origin-ui-${STAGE}
${PREFIX}-origin-api-${STAGE}

For e.g in order to create ptt-origin-ui-stable run the script with:

PREFIX=ptt STAGE=stable TEAM=<team> ./provision-heroku-origin.sh

Note: This script assumes that Heroku CLI tool is installed and your are logged in https://devcenter.heroku.com/articles/heroku-cli

Energy Attribute Certificates

Energy Attribute Certificates, or EACs, is an official document which guarantees that produced energy comes from a renewable source. There are different standards that regulate how data is stored and validated. In Europe, this document is called Guarantee of Origin (GO), in North America, it's called Renewable Energy Certificate (REC), and in parts of Asia, Africa, the Middle East, and Latin America governing standard is International REC (I-REC). Standards do vary, but they all share the same core principles.

The main purpose of EACs is to act as an accounting vehicle to prove that consumed energy came from a renewable source. EACs are mostly used to address sustainability reports regarding Scope 2 emissions.

Deployment

For deployment instructions please refer to Deployment wiki page.

Contribution guidelines

If you want to contribute to Origin, be sure to follow classic open source contribution guidelines (described below).

  1. Commiting a change
    • Fork the repository
    • Make a change to repo code
    • Commit the change to the master branch
  2. Pull request