Skip to main content

HiiConnect Cash Changer Service

This is the architectural documentation for cashchangers. It describes the architecture of cashchangers. and is the source of truth for the system architecture.

See the Solution Review Board (SRB) for more information on what documentation to provide for all software systems. This documentation must be updated as the system evolves to always describe the system in its current state.

:book: Contents

✏️ How to update generated content

Parts of the documentation are generated using the following tooling.

C4 diagrams

All C4 diagrams must be created with Structurizr DSL. Use the provided dsl2png.sh script to create PNG images from the DSL. Use the --watch flag while making changes. This will give a live preview of the diagram(s) in your browser at http://localhost:3000.

./dsl2png.sh --watch

💡 On Windows 10? Use dsl2png.cmd instead.

Architecture decision records (ADRs)

Use ADRs to track architectural decisions. All significant decisions should be tracked to help future developers understand the reasons a technology is used. It will also help developers to replace technology when they understand why it was used from the start.

Use the provided adr.sh script to create ADR entries and to update the ADR log in this document. The script combines adr-tools and adr-log. See adr-tools docs for available commands.

./adr.sh help

💡 On Windows 10? Use adr.cmd instead.