- Why we like to Visualise Architecture.
- C4 Model and Structurizr are one way to achieving this.
- See more tools here.
- Knowledge and understanding of C4 Model.
- Watch Diagrams as Code 2.0 for an explanation/motivation for why Structurizr.
- Learning the Structurizr DSL is important but not necessary for this demo.
There are two not an official extensions. I would recommend the simple Structurizr DSL syntax highlighter.
The other extensions are complicated and can make external calls to render diagrams.
Clone this Repo to get started and you can use Structurizr Lite by:
git clone [email protected]:madetech/structurizr-template.git
cd structurizr-template
docker pull structurizr/lite
docker run -it --rm -p 8080:8080 -v $PWD:/usr/local/structurizr structurizr/lite
Open your browser and go to localhost:8080.
This will allow you to you to use Structurizr website locally as a playground with the example included.
Another company has created a tool for this use case: Structurizr Site Generatr
This tool includes:
- Boilerplate structure for a static website hosting C4 Diagrams
- Support for any Architecture Decision Records
- Other documentation defined in the Structurizr DSL
- You can get various exports using this tool (
svg,png,puml)
A static site generator for C4 architecture models created with Structurizr DSL. See Background for the story behind this tool.
Click here to see an example of a generated site based on the Big Bank plc example from https://structurizr.com. This site is generated from the example workspace in this repository.
You can write Structurizr DSL and publish it to a site a client or team can browse. It also includes support for other documentation and Architecture Decision Records. It should be a one stop shop for documenting your projects.
GitHub Pages hosts this repo as an example. It is built and deployed via the GitHub Action here.
Install:
brew tap avisi-cloud/tools
brew install structurizr-site-generatr
Run the following for a live updating/development site.
structurizr-site-generatr serve -w workspace.dsl -a assets
Run the following for a static site. E.g. GitHub Pages
structurizr-site-generatr generate-site -w workspace.dsl -a assets --branches main --default-branch main
Note: Assets can be found in the assets folder. They can whatever they need to be, e.g. images.
Support
Read Structurizr Site Generatr for problems with the tool.