open-energymesh-offline-first-distribute/README.md

Open-EnergyMesh (Offline-First MVP)

Overview

• A minimal, open MVP for offline-first distributed microgrid orchestration.
• Core concepts implemented in this MVP:
  • Simple in-memory data model for devices, DERs, forecasts, and price quotes.
• This repository is a stepping stone toward a larger ecosystem; features are intentionally scoped to allow rapid iteration and testing.

Project layout

• package.json: npm metadata and test script.
• src/mesh.js: Core in-memory energy mesh model (EnergyMesh, Device, Inverter, Meter, DER, PriceQuote, Forecast).
• test/test.js: Basic unit test verifying energy-flow calculation.
• AGENTS.md: Architecture and testing guidance for future agents.
• README.md: This file.
• test.sh: Executable to run tests in CI/local environment.
• READY_TO_PUBLISH: marker file to signal completion (created when ready).

How to run locally

• Install dependencies: npm install
• Run tests: npm test
• Or run the provided test script: ./test.sh

Extending the MVP

• Add more detailed data models (Event, Trade, etc.).
• Implement a lightweight mesh protocol layer and offline-sync logic.
• Introduce a forecasting and pricing plug-in interface.
• Add governance/peer-to-peer trading scaffolding in a separate module.

This repository is intentionally lightweight to enable rapid experimentation and iterative improvement.