Skip to content
Snippets Groups Projects
README.md 2.03 KiB
Newer Older
# RuQaD Architecture Documentation

This repository contains the RuQaD architecture documentation.

We use a doc-as-code approach based on [arc42](https://arc42.org/) and the [C4
model](https://c4model.com/) using the
[structurizr](https://docs.structurizr.com/) tools for generating a static
documentation html site.

## Sources

The src directory contains the doc-as-code sources.

* [src/architecture.md](./src/architecture.md) - the arc42-based architecure documentation.
* [src/workspace.dsl](./src/workspace.dsl) - the root file of the structurizr workspace.
* [src/views/](./src/views/) - contains the structurizr views.
* [src/model/](./src/model/) - contains the structurizr model.
* [src/decisions/](./src/decisions/) - contains Architecture Decision Records (adr).

## Tools

The tools directory contains the following tools:

Daniel Hornung's avatar
Daniel Hornung committed
* [tools/serve](./tools/serve) - serve a static site on http://localhost:8080 which renders the documentation,
  including diagrams.
* [tools/validate](./tools/validate) - validate your structurizr workspace.
Daniel Hornung's avatar
Daniel Hornung committed
* [tools/structurizer-lite](./tools/structurizer-lite) - the original structurizer-lite tool. Use this to interactively
  layout single diagrams.
Daniel Hornung's avatar
Daniel Hornung committed
All tools require docker, more information in the [readme](tools/README.md) in the tools directory.
## Background

The RuQaD Demonstrator is the main product of the project "RuQaD Batteries - Reuse Quality-assured Data for
Batteries". The project is a sub-project of the [FAIR Data Spaces](https://www.nfdi.de/fair-data-spaces/) project, supported by the German Federal Ministry
of Education and Research under the Förderkennzeichen [FAIRDS05 (PR697238)](https://foerderportal.bund.de/foekat/jsp/SucheAction.do?actionMode=view&fkz=FAIRDS05)

## License

* This architecture documentation is published under [CC-BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0/)
* Copyright (C) 2024 IndiScale GmbH <mailto:info@indiscale.com>
* Copyright (C) 2024 Timm Fitschen
* Copyright (C) 2024 Alexander Schlemmer
* Copyright (C) 2024 Daniel Hornung
* Copyright (C) 2024 Henrik tom Wörden