EnergyWeb Zero

Zero description.

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

Table of Contents

• Table of Contents
• Packages
  • Applications, Infrastructure and Demo
  • Packages types
    • Stable
    • Canary
    • Preview
• Installation
• Build
• Test
• Run demo
  • Preparation
  • Running
  • Heroku environment provisioning
• Energy Attribute Certificates
• Key modules and components
  • Key repositories
  • Other components
• Deployment
• Contribution guidelines

Stable

Stable versions of Zero are built during release branch build.

Canary

Canary versions of Zero are are built 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 versions of Zero 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 latest Node LTS
2. Make sure you have Java runtime installed
3. Install Postgres 12.x+ and create a new database named zero.

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=zero -d -p 5432:5432 postgres

4. 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.

Installation

yarn

Build

yarn build

Test

yarn e2e

Run demo

yarn start

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

Deployment

For deployment instructions please refer to Deployment wiki page.

Contribution guidelines

If you want to contribute to Zero, 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
   • Open a pull request from your fork master branch
   • Request code reviews from @arkadiuszsz
   • Once the PR is approved and the build passes, it will be merged to the master branch