Skip to content

Latest commit

 

History

History
74 lines (47 loc) · 3.17 KB

README.md

File metadata and controls

74 lines (47 loc) · 3.17 KB
Raw

Architecture Decision Records (ADR) Website 📒

General Availability (GA) Website Up Website ADRs

This repository employs Log4Brains to publish all Architectural Decision Records (ADRs) within it. These ADRs are to keep track of all decisions made across projects within my GitHub profile. If a project grows significantly then all relevant ADRs will be moved to its repository.

Architecture Decision Records

Why? 🤔

  1. To maintain a log of all decisions for historical and recall purposes. It's easy to forget WHY a certain approach was taken.
  2. For visibility... Decisions in software development are trade-offs that depend on the situation and context. This will help in understanding certain decisions.
  3. To practice crafting ADRs. This thought-provoking process will ideally lead to better decision-making.
  4. To instill a level of professionalism in side projects.

Structure 🧱

There are two distinct levels of ADRs:

  • Global: Decisions that impact all repositories.
  • Repository specific: Decisions exclusive to a particular project or product within a repository.

The repository-specific ones are added as 'packages' within the Log4Brains structure. You can identify these by the package name next to the title within the user interface.

Whats the damage (WTD)? 💰

$0 per month.

Technologies Used 🧑‍💻

Next JS HTML5 JavaScript CSS3

Hosting and Deployment 🚀

  • Hosting: Github Pages
  • Deployment: Github Actions

Architecture Overview 🏛️

  • Frontend component only.
  • No external data sources or API's consumed.

Development 🧑‍💻

If not already done, install Log4brains:

npm install -g log4brains

To preview the knowledge base locally, run:

log4brains preview

In preview mode, the Hot Reload feature is enabled: any change you make to a markdown file is applied live in the UI.

To create a new ADR interactively, run:

log4brains adr new

References 🌳