https://github.com/sapientpants/structurizr-macros

Macros to make using Structurizr more convenient
https://github.com/sapientpants/structurizr-macros

architecture diagram kotlin structurizr uml uml-diagram

Last synced: about 2 months ago
JSON representation

Macros to make using Structurizr more convenient

• Host: GitHub
• URL: https://github.com/sapientpants/structurizr-macros
• Owner: sapientpants
• License: mit
• Created: 2019-08-02T20:36:14.000Z (almost 6 years ago)
• Default Branch: trunk
• Last Pushed: 2020-09-03T02:45:01.000Z (over 4 years ago)
• Last Synced: 2023-07-28T22:08:48.071Z (almost 2 years ago)
• Topics: architecture, diagram, kotlin, structurizr, uml, uml-diagram
• Language: Kotlin
• Size: 396 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# structurizr-macros

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.sapientpants/structurizr-macros/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.sapientpants/structurizr-macros)

[![Build Status](https://travis-ci.com/sapientpants/structurizr-macros.svg?branch=trunk)](https://travis-ci.com/sapientpants/structurizr-macros)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=structurizr-macros&metric=alert_status)](https://sonarcloud.io/dashboard?id=structurizr-macros)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=structurizr-macros&metric=coverage)](https://sonarcloud.io/dashboard?id=structurizr-macros)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=structurizr-macros&metric=bugs)](https://sonarcloud.io/dashboard?id=structurizr-macros)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=structurizr-macros&metric=sqale_index)](https://sonarcloud.io/dashboard?id=structurizr-macros)

Macros (or procedures if you prefer) to make it more convenient to create Structurizr diagrams in a consistent manner.

## Installation

### Java

Java >= 8 and <= 12

```sh

brew tap AdoptOpenJDK/openjdk

brew cask install adoptopenjdk-12

```

### Gradle

Add the dependency to `build.gradle.kts`

```kotlin

implementation("io.github.sapientpants:structurizr-macros:VERSION")

```

### Maven

Add the dependency to `pom.xml`

```xml

    io.github.sapientpants

    structurizr-macros

    VERSION

```

## Usage

### Architecture Documentation

- [Arc42](doc/architecture-documentation/arc42.md)

- [Architecture Decision Records](doc/architecture-documentation/architecture-decision-records.md)

- [Structurizr](doc/architecture-documentation/structurizr.md)

- [Viewpoints and Perspectives](doc/architecture-documentation/viewpoints-and-perspectices.md)

### Rendering

- [PlantUML](doc/rendering/plantuml.md)

- [Structurizr](doc/rendering/structurizr.md)

### Examples

See [https://github.com/sapientpants/structurizr-macros-examples](https://github.com/sapientpants/structurizr-macros-examples)

## License

MIT © [Marc Tremblay](https://github.com/sapientpants)