Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hadii-tech/striff-lib

A library for generating striff diagrams.
https://github.com/hadii-tech/striff-lib

diagram striff uml

Last synced: about 1 month ago
JSON representation

A library for generating striff diagrams.

Host: GitHub
URL: https://github.com/hadii-tech/striff-lib
Owner: hadii-tech
License: agpl-3.0
Created: 2020-06-17T06:11:14.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-11-11T20:48:05.000Z (about 1 month ago)
Last Synced: 2024-11-11T21:34:25.107Z (about 1 month ago)
Topics: diagram, striff, uml
Language: Java
Homepage: https://striff.io
Size: 84.9 MB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # [striff-lib](https://striff.io)

[![maintained-by](https://img.shields.io/badge/Maintained%20by-Hadii%20Technologies-violet.svg)](https://hadii.ca) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.hadii-tech/striff-lib/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.hadii-tech/striff-lib) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f52c429a0a514abf86d252fe263d7c17)](https://www.codacy.com/gh/hadii-tech/stiff-lib?utm_source=github.com&utm_medium=referral&utm_content=hadii-tech/stiff-lib&utm_campaign=Badge_Grade) [![codecov](https://codecov.io/gh/hadii-tech/clarpse/branch/master/graph/badge.svg?token=7uf2jQMlH1)](https://codecov.io/gh/hadii-tech/clarpse) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

### Architectural Diagrams, Made For Code Reviews.

Striffs leverage the basic premise surrounding the utility of line-wise code diffs at an architectural level, and encourage a more natural understanding of code changes through a "top-down" approach which more closely resembles the lens from which the system was designed and intended to be understood. 

![sample_striff](striff.png)

### Getting Started

* Ensure `graphviz` is installed on your system.

* Execute `mvn clean package assembly:single` to  build jar. 

* `StriffAPITest.java` demonstrates how to use this library to generate striff diagrams.