E-SOH C4 Architecture

Quick Start (PlantUML & C4)

• install PlantUML from your favourite package repository (e.g. sudo apt install plantuml)
• install PlantUML plugin to vscode
• open .puml file from cloned repo and press alt-D (option + D on MacOS) to open preview tab
• enjoy editing
• commit and push changes to git repo

Quick Start (diagrams.net, formerly known as draw.io)

• go to https://app.diagrams.net
• select GitHub
• authorize access to this repository
• open relevant drawio file
• add c4 library for shapes
• edit
• save (add commit message when saving)

References:

• C4 model: https://c4model.com/
• C4-plantUML: https://github.com/plantuml-stdlib/C4-PlantUML
• PlantUML plugin for vscode: https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml