Energy Web DER management API

This project contains the source code of the many parts that make up the DER management API.

🗂 Project structure

.
├── .github              # github actions
├── aggregator           # backend owned by an aggregator
├── app                  # frontend application for both aggregators and common users
├── contract             # all the smart contract to deploy on the blockchain
├── der                  # DER simulator as an IOT device
├── docker               # docker stack
├── docs                 # documentation and architecture's schema
├── prosumer             # backend owned by the prosumer
├── .gitattributes       # .gitattributes file
├── .gitignore           # .gitignore file
├── package.json         # npm package that uses the workspaces functionalities of npm >=7
├── LICENSE              # open license of the project
└── README.md            # THIS FILE

🧾 Requirements

• Node.js 16
• npm 7.x
• Docker

NOTE: Node.js version's should be 16.10 <= v < 17. You may encounter some incompatibilities otherwise

⚙️ Docker-compose configuration

To configure the docker-compose, read the documentation. You can also use a docker-compose.override.yml to set some more confidential settings, like private keys.

🐳 Launch the Docker-compose

In the docker folder of the project, launch the configuration described in the docker-compose.yaml file with

docker compose up -d

To stop the stack, use

docker compose down

Visualization

Here's the stack this Docker-compose will produce:

What follows is the typical flow of the API: