https://github.com/plutov/c4-diagram-example
https://github.com/plutov/c4-diagram-example
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/plutov/c4-diagram-example
- Owner: plutov
- License: mit
- Created: 2024-01-18T08:49:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-12T15:51:59.000Z (10 months ago)
- Last Synced: 2025-04-11T21:52:11.821Z (25 days ago)
- Language: ASL
- Size: 11.7 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Software Architecture Diagram example using C4 model
[Read the full article](https://packagemain.tech/p/software-architecture-diagrams-c4)
[view diagram](https://plutov.github.io/c4-diagram-example/master/task-management-system/container/)
This repository is an example of creating Software architecture diagrams using the C4 model.
It is not showing all the features of C4 or DSL, but serves as a starting point.
`diagram.dsl` describes a simple task management system. This example doesn't contain the Code layer.
# Github Action
There is a workflow as part of this repository that generates a static page and publishes it to Github Pages.
There are few other options for viewing the diagram:
- Upload to Structurizr
- Render into Mermaid format that Github can display
- Use PlantUML viewer
# Resources
- [C4 Model](https://c4model.com/)
- [DSL Language Reference](https://docs.structurizr.com/dsl/language)
- [C4 DSL Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=systemticks.c4-dsl-extension)