Skip to content

mbouchenoire/lowfer

Repository files navigation

Lowfer

License   ci-cd Docker Hub  

Lowfer is a simple tool that helps software engineers and architects document, discuss & analyse software design and architecture.

Define your architecture using YAML (or anything similar) files and host them in a Git repository, Lowfer will then use this repository as it's "database".

Using a Git repository as a source of truth for your architecture definition allows you to treat your architecture like any software component (with versioning, reviews, etc...).

Features

Web Studio

Live-edit your architecture definition within a Web IDE: Studio

Issues

Find issues in your architecture using a built-in static-analysis tool: Issues

Quick Start

Lowfer is contained within a single Docker image. You can run it locally and access it in your browser (http://localhost:8080) with this command:

docker run \
    -e ARCHITECTURES_REPOSITORY_URI=https://github.com/mbouchenoire/lowfer.git \
    -e ARCHITECTURES_REPOSITORY_BRANCH=master \
    -e ARCHITECTURES_REPOSITORY_PATH=src/test/resources/architectures/demo \
    -p 8080:8080 \
    mbouchenoire/lowfer:0.3.1