PACKAGE NAME

Description

Overview of package. {Package} is a module-based library built with xxx.

//Purpose of package, sdk, etc.

{Package} is a component of the Energy Web Decentralized Operating System

See {PACKAGE} deployed [here](link to Switchboard, Zero if applicable)

Installation

This is a Node.js module available through the npm registry.

Requirements

Before installing, download and install Node.js. Node.js xxx or higher is required.

Installation is done using the following commands:

$ npm install

Build

$ npm run build

Run

$ npm run start

Docker

Instructions how to run app with Docker.

docker run --rm -p 8000:8000 ghcr.io/energywebfoundation/{PACKAGE}:latest

Build docker image:

docker build --tag {PACKAGE} -f ./Dockerfile .

Kubernetes

Instructions how to deploy app on Kubernetes.

helm install ...

Testing (delete if not needed)

Testing Strategy

Integration Tests (delete if not needed)

$ npm run test

Unit Tests (delete if not needed)

$ npm run test

For more details, visit the [installation guide](//LINK TO READ THE DOCS INSTALL PAGE)

Documentation

• ReadTheDocs

Who is Using {Package}?

//For origin, 24/7, Zero might be good to have a few examples of implementations to give context of how its used

Contributing Guidelines

See contributing.md

Questions and Support

For questions and support please use Energy Web's Discord channel

Or reach out to our contributing team members

• TeamMember: email [email protected]

EW-DOS

//This should be the same in every repo. The Energy Web Decentralized Operating System is a blockchain-based, multi-layer digital infrastructure.

The purpose of EW-DOS is to develop and deploy an open and decentralized digital operating system for the energy sector in support of a low-carbon, customer-centric energy future.

We develop blockchain technology, full-stack applications and middleware packages that facilitate participation of Distributed Energy Resources on the grid and create open market places for transparent and efficient renewable energy trading.

• To learn about more about the EW-DOS tech stack, see our documentation.

• For an overview of the energy-sector challenges our use cases address, go here.

For a deep-dive into the motivation and methodology behind our technical solutions, we encourage you to read our White Papers:

• Energy Web White Paper on Vision and Purpose
• Energy Web White Paper on Technology Detail

Connect with Energy Web

• Twitter
• Discord
• Telegram

License

This project is licensed under the GNU General Public License v3.0 or later - see the LICENSE file for details