clemlesne / c4-plantuml-boilerplate

Boilerplate for C4 model architecture on Git.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

C4 PlantUML boilerplate

General

Architecture

Architecture nomenclature is based on the C4 model.

System context:

System context diagram (C4 model)

Container:

Container diagram (C4 model)

Component:

Component diagram (C4 model)

Install

Documentation:

  1. Install PlantUML dependency with brew install graphviz (MacOS), winget install graphviz (Windows), yum install graphviz (Linux Fedora), apt install graphviz (Linux Debian-based)
  2. Confirm dot is installed on your PATH with dot --version

Test

Documentation:

  1. Run Lint with make docs-lint

Upgrade

Documentation:

  1. Update PLANTUML_VERSION variable in the Makefile file with the latest PlantUML version
  2. Run make docs-install command

Authors

About

Boilerplate for C4 model architecture on Git.


Languages

Language:Makefile 100.0%