# kristiandl/yarn-project-ai architecture

> Architecture diagram of the GitHub repository kristiandl/yarn-project-ai, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kristiandl/yarn-project-ai
- Repository: https://github.com/kristiandl/yarn-project-ai

## Overview

Awesome Garn is a single-user JavaFX desktop app for managing a personal yarn inventory, stored locally without a database or external services. The workflow is to add or edit yarn through a form, validate and persist changes, then browse, search, filter, sort, and delete inventory items; a separate view calculates inventory statistics. The README documents these capabilities and the layer structure. Some view/controller details and statistics internals were not excerpted, so the graph limits those links to documented or indexed evidence.

Main entry points: [`src/main/java/awesomegarn/controller/YarnController.java`](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnController.java) (Inventory controller), [`src/main/java/awesomegarn/view/ViewHandler.java`](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ViewHandler.java) (View navigation), [`src/main/java/awesomegarn/model/Yarn.java`](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Yarn.java) (Yarn record), [`src/main/java/awesomegarn/Main.java`](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/Main.java) (JavaFX startup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Desktop interface"]
  node_app["JavaFX startup<br/>[Main.java]"]
  node_navigation["View navigation<br/>[ViewHandler.java]"]
  node_overview["Inventory overview"]
  node_form["Add/edit form<br/>[YarnFormPane.java]"]
  node_addview["Add screen<br/>[AddYarnView.java]"]
  node_editview["Edit screen<br/>[EditYarnView.java]"]
  node_statisticsview["Statistics screen"]
  node_confirm["Delete confirmation"]
  node_errors["Error overlays<br/>[ErrorOverlay.java]"]
end

subgraph group_logic["Inventory workflow"]
  node_controller["Inventory controller"]
  node_validation["Input validation<br/>[YarnValidator.java]"]
  node_filter["Search and filters<br/>[YarnFilter.java]"]
  node_sorting["Sort options<br/>[SortOption.java]"]
  node_data["Form data<br/>[YarnData.java]"]
end

subgraph group_domain["Yarn domain"]
  node_collection["Yarn collection"]
  node_yarn["Yarn record<br/>[Yarn.java]"]
  node_statistics["Inventory statistics<br/>[Statistics.java]"]
  node_enumtypes["Yarn attributes<br/>[Material.java]"]
end

subgraph group_persistence["Local persistence"]
  node_storageapi["Storage interface<br/>[YarnStorage.java]"]
  node_binstorage[("Binary file storage")]
end

node_user(("Inventory user"))

node_user -->|"launches"| node_app
node_app -->|"starts UI"| node_navigation
node_navigation -->|"shows"| node_overview
node_navigation -->|"opens"| node_addview
node_navigation -->|"opens"| node_editview
node_navigation -->|"opens"| node_statisticsview
node_navigation -->|"shows"| node_confirm
node_navigation -->|"shows"| node_errors
node_addview -->|"uses"| node_form
node_editview -->|"uses"| node_form
node_overview -->|"requests navigation"| node_navigation
node_form -.->|"submits changes"| node_controller
node_overview -->|"requests inventory"| node_controller
node_statisticsview -->|"requests statistics"| node_controller
node_confirm -->|"deletes item"| node_controller
node_controller -->|"validates input"| node_validation
node_controller -->|"mutates inventory"| node_collection
node_controller -->|"saves inventory"| node_storageapi
node_controller -->|"calculates statistics"| node_statistics
node_controller -->|"matches items"| node_filter
node_controller -->|"sorts results"| node_sorting
node_validation -->|"validates fields"| node_data
node_controller -->|"creates records"| node_yarn
node_collection -->|"holds records"| node_yarn
node_binstorage -->|"implements"| node_storageapi
node_app -->|"configures storage"| node_binstorage
node_yarn -->|"uses attributes"| node_enumtypes
node_statistics -->|"aggregates records"| node_yarn

click node_app "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/Main.java"
click node_navigation "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ViewHandler.java"
click node_overview "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/YarnOverviewView.java"
click node_form "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/YarnFormPane.java"
click node_addview "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/AddYarnView.java"
click node_editview "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/EditYarnView.java"
click node_statisticsview "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/StatisticsView.java"
click node_confirm "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ConfirmDeleteOverlay.java"
click node_errors "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ErrorOverlay.java"
click node_controller "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnController.java"
click node_validation "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnValidator.java"
click node_filter "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnFilter.java"
click node_sorting "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/SortOption.java"
click node_data "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnData.java"
click node_collection "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/YarnCollection.java"
click node_yarn "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Yarn.java"
click node_statistics "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Statistics.java"
click node_enumtypes "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Material.java"
click node_storageapi "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/storage/YarnStorage.java"
click node_binstorage "https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/storage/BinaryYarnStorage.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_navigation,node_overview,node_form,node_addview,node_editview,node_statisticsview,node_confirm,node_errors,node_user toneBlue
class node_controller,node_validation,node_filter,node_sorting,node_data toneAmber
class node_collection,node_yarn,node_statistics,node_enumtypes toneMint
class node_storageapi,node_binstorage toneRose
```

## Components

### Desktop interface

- [JavaFX startup](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/Main.java): `src/main/java/awesomegarn/Main.java`
- [View navigation](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ViewHandler.java): `src/main/java/awesomegarn/view/ViewHandler.java`
- [Inventory overview](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/YarnOverviewView.java): `src/main/java/awesomegarn/view/YarnOverviewView.java`
- [Add/edit form](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/YarnFormPane.java): `src/main/java/awesomegarn/view/YarnFormPane.java`
- [Add screen](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/AddYarnView.java): `src/main/java/awesomegarn/view/AddYarnView.java`
- [Edit screen](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/EditYarnView.java): `src/main/java/awesomegarn/view/EditYarnView.java`
- [Statistics screen](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/StatisticsView.java): `src/main/java/awesomegarn/view/StatisticsView.java`
- [Delete confirmation](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ConfirmDeleteOverlay.java): `src/main/java/awesomegarn/view/ConfirmDeleteOverlay.java`
- [Error overlays](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/view/ErrorOverlay.java): `src/main/java/awesomegarn/view/ErrorOverlay.java`

### Inventory workflow

- [Inventory controller](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnController.java): `src/main/java/awesomegarn/controller/YarnController.java`
- [Input validation](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnValidator.java): `src/main/java/awesomegarn/controller/YarnValidator.java`
- [Search and filters](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnFilter.java): `src/main/java/awesomegarn/controller/YarnFilter.java`
- [Sort options](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/SortOption.java): `src/main/java/awesomegarn/controller/SortOption.java`
- [Form data](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/controller/YarnData.java): `src/main/java/awesomegarn/controller/YarnData.java`

### Yarn domain

- [Yarn collection](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/YarnCollection.java): `src/main/java/awesomegarn/model/YarnCollection.java`
- [Yarn record](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Yarn.java): `src/main/java/awesomegarn/model/Yarn.java`
- [Inventory statistics](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Statistics.java): `src/main/java/awesomegarn/model/Statistics.java`
- [Yarn attributes](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/model/Material.java): `src/main/java/awesomegarn/model/Material.java`

### Local persistence

- [Storage interface](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/storage/YarnStorage.java): `src/main/java/awesomegarn/storage/YarnStorage.java`
- [Binary file storage](https://github.com/kristiandl/yarn-project-ai/blob/main/src/main/java/awesomegarn/storage/BinaryYarnStorage.java): `src/main/java/awesomegarn/storage/BinaryYarnStorage.java`

### Other components

- **Inventory user**

## Connections

- Inventory user → JavaFX startup: launches (evidence: `README.md`)
- JavaFX startup → View navigation: starts UI (evidence: `src/main/java/awesomegarn/Main.java`)
- View navigation → Inventory overview: shows (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- View navigation → Add screen: opens (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- View navigation → Edit screen: opens (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- View navigation → Statistics screen: opens (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- View navigation → Delete confirmation: shows (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- View navigation → Error overlays: shows (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- Add screen → Add/edit form: uses (evidence: `src/main/java/awesomegarn/view/AddYarnView.java`)
- Edit screen → Add/edit form: uses (evidence: `src/main/java/awesomegarn/view/EditYarnView.java`)
- Inventory overview → View navigation: requests navigation (evidence: `src/main/java/awesomegarn/view/YarnOverviewView.java`)
- Add/edit form → Inventory controller: submits changes
- Inventory overview → Inventory controller: requests inventory (evidence: `src/main/java/awesomegarn/view/YarnOverviewView.java`)
- Statistics screen → Inventory controller: requests statistics (evidence: `src/main/java/awesomegarn/view/StatisticsView.java`)
- Delete confirmation → Inventory controller: deletes item (evidence: `src/main/java/awesomegarn/view/ViewHandler.java`)
- Inventory controller → Input validation: validates input (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Inventory controller → Yarn collection: mutates inventory (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Inventory controller → Storage interface: saves inventory (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Inventory controller → Inventory statistics: calculates statistics (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Inventory controller → Search and filters: matches items (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Inventory controller → Sort options: sorts results (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Input validation → Form data: validates fields (evidence: `src/main/java/awesomegarn/controller/YarnValidator.java`)
- Inventory controller → Yarn record: creates records (evidence: `src/main/java/awesomegarn/controller/YarnController.java`)
- Yarn collection → Yarn record: holds records (evidence: `src/main/java/awesomegarn/model/YarnCollection.java`)
- Binary file storage → Storage interface: implements (evidence: `src/main/java/awesomegarn/storage/BinaryYarnStorage.java`)
- JavaFX startup → Binary file storage: configures storage (evidence: `src/main/java/awesomegarn/Main.java`)
- Yarn record → Yarn attributes: uses attributes (evidence: `src/main/java/awesomegarn/model/Yarn.java`)
- Inventory statistics → Yarn record: aggregates records (evidence: `src/main/java/awesomegarn/model/Statistics.java`)
