Git Product home page Git Product logo

docker-c4-uml-diagrams's Introduction

dac - Diagrams as Code

Combinations of Diagrams as Code tools, aiming for a minimal workflow.

Motivation

Diagrams really aid understanding a software system or architecture and the tooling around such diagramming techniques are not quite straight forward or need installation of many dependencies. We use a minimal docker image and container to run all diagram processing.

Tools

The project includes ability to generate diagrams from code using:

  • Python - diagrams. Generates architecture diagrams from python code.
  • Uml - plantuml. Generates any uml diagram.
  • C4 Model - c4-plantuml. Generates diagrams from uml code with C4 resources available.
  • Docker - To run and containerize the tools.

Example Outputs (png)

C4

test_c4

Uml

test

Python

consumer

Workflow

make help

Run container

make run-container

  • builds the docker image and runs the container

Generate Diagrams

C4 Model

filename=test_c4 inputext=puml outputext=png make diagrams-uml

UML

filename=test inputext=uml outputext=png make diagrams-uml

Python

filename=consumer inputext=py outputext=png make diagrams-py

Stop container

make stop-container

docker-c4-uml-diagrams's People

Contributors

nosahama avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

harmonwood

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.