Zero description.
🚧 Documentation available at https://energy-web-foundation-origin.readthedocs-hosted.com/en/latest/ 🚧
- Table of Contents
- Packages
- Installation
- Build
- Test
- Run demo
- Energy Attribute Certificates
- Key modules and components
- Deployment
- Contribution guidelines
Stable versions of Zero are built during release
branch build.
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 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
- Make sure you are using latest Node LTS
- Make sure you have Java runtime installed
- 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
- 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.
yarn
yarn build
yarn e2e
yarn start
Visit the UI at: http://localhost:3000.
For deployment instructions please refer to Deployment wiki page.
If you want to contribute to Zero, be sure to follow classic open source contribution guidelines (described below).
- Commiting a change
- Fork the repository
- Make a change to repo code
- Commit the change to the
master
branch
- 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
- Open a pull request from your fork