diff --git a/README.md b/README.md index 95832a6..3823ebf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,28 @@ # DGF Prototype Decentralized Governance Framework +## Project Architecture + +| directory | description | +| --------- | ----------- | +| ethereum | Solidity smart contracts and associated deploy scripts | +| backend | Node.js application with an HTTP API that also functions as a Matrix bot and Ethereum client | +| frontend | React.js frontend with a WebApp route and a Matrix Widget route | + +### Data Flow Diagram + +```mermaid +flowchart TD + Blockchain <-- ethers --> API + Blockchain <-- Web3
+ MetaMask --> WebApp + Blockchain <-- Web3
+ MetaMask --> Widget + WebApp <-- HTTPS --> API + Widget <-- HTTPS --> API + Widget <-- matrix-widget-api --> Matrix + API <-- matrix-bot-sdk --> Matrix +``` + + ## Local development setup Clone this repository to a directory on your machine