# appreciated/vaadin-app-layout architecture

> Architecture diagram of the GitHub repository appreciated/vaadin-app-layout, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/appreciated/vaadin-app-layout
- Repository: https://github.com/appreciated/vaadin-app-layout

## Overview

##### Project type and purpose
- This repository is a Maven multi-module Java library (an open-source Vaadin add-on) that provides ready-to-use templates for the `<app-layout>` WebComponent.
- It includes three logical areas:
- Core add-on module (`app-layout-addon`)
- A set of demo/example applications (`app-layout-examples/...`)
- UI integration tests (`app-layout-ui-tests`)
- There is also a root aggregator POM (`pom.xml`), CI definition (`azure-pipelines.yml`), and GitHub ISSUE templates.

##### File structure
- Top-level:
- `.github/` → issue/PR templates
- `pom.xml` → root aggregator POM, lists modules
- `azure-pipelines.yml` → CI/CD pipeline
- `app-layout-addon/` → core add-on module
- `app-layout-examples/` → subfolders for each example project (annotation, theme, spring, etc.)
- `app-layout-ui-tests/` → integration/UI test suite
- Core module (`app-layout-addon`):
- `pom.xml`, `package.json`, `assembly/` → build packaging (Maven + npm)
- `src/main/java/com/github/appreciated/app/layout/...` → Java API (builders, components, annotations)
- `src/main/resources/META-INF/resources/frontend/...` → static WebComponent assets (CSS, JS) packaged into the JAR
- `src/test/` → unit tests
- Examples: follow the same structure (each has its own `pom.xml`, Java sources under `src/main/java`, static resources under `src/main/resources/META-INF/resources/frontend`, and in some cases `package.json`).
- UI tests: a separate Maven module with Java integration tests under `src/main/java` and `src/test/java`, covering end-to-end behaviors of different layouts.

##### README for additional insights
- Describes the add-on as “a collection of ready to use templates for the Webcomponent `<app-layout>`.”
- Points out supported Vaadin versions, demo URL, and build instructions (`mvn install`, `jetty:run`).

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Repository Modules"
        RootPOM["Root Aggregator (pom.xml)"]:::root
        subgraph "Core Add-on Module"
            API["Java API Layer"]:::core
            Resources["Resource Packaging Layer"]:::core
            Build["Build Scripts & Packaging"]:::core
        end
        subgraph "Example Applications"
            ExamplesAgg["Examples Aggregator (pom.xml)"]:::example
            Annotation["Annotation Example"]:::example
            Material["Material Theme Example"]:::example
            Notification["Notification Example"]:::example
            Plain["Plain Example"]:::example
            Profile["Profile Example"]:::example
            Search["Search Example"]:::example
            Spring["Spring Example"]:::example
            Sticky["Sticky Footer Example"]:::example
            Theme["Theme Example"]:::example
        end
        UI["UI Test Suite"]:::test
    end

    subgraph "CI/CD Pipeline"
        CI["Azure Pipelines"]:::ci
    end

    subgraph "Runtime & External"
        Repo["Artifact Repository"]:::external
        DevApp["Developer's Vaadin App"]:::external
        Browser["Browser Client"]:::external
    end

    subgraph "Repository Resources"
        Bug["bug_report.md"]:::resource
        Enhancement["enhancement.md"]:::resource
        Feature["feature_request.md"]:::resource
        Question["question.md"]:::resource
    end

    RootPOM -->|builds modules| API
    RootPOM -->|builds modules| ExamplesAgg
    RootPOM -->|builds modules| UI
    ExamplesAgg -->|depends on| API
    UI -->|depends on| API
    CI -->|triggers build| RootPOM
    CI -->|publishes artifact| Repo
    API -->|packages classes & assets| Repo
    DevApp -->|imports via Maven| API
    DevApp -->|at runtime registers components| Browser
    Resources -->|serves static assets| Browser
    Bug -->|templates| RootPOM
    Enhancement -->|templates| RootPOM
    Feature -->|templates| RootPOM
    Question -->|templates| RootPOM

    classDef root fill:#f9f,stroke:#333,stroke-width:1px
    classDef core fill:#bbf,stroke:#333,stroke-width:1px
    classDef example fill:#bfb,stroke:#333,stroke-width:1px
    classDef test fill:#fbf,stroke:#333,stroke-width:1px
    classDef ci fill:#fbc,stroke:#333,stroke-width:1px
    classDef external fill:#ddd,stroke:#333,stroke-width:1px
    classDef resource fill:#fee,stroke:#333,stroke-width:1px

    click RootPOM "https://github.com/appreciated/vaadin-app-layout/blob/master//pom.xml"
    click CI "https://github.com/appreciated/vaadin-app-layout/blob/master//azure-pipelines.yml"
    click API "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-addon/src/main/java/com/github/appreciated/app/layout/component/"
    click API "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-addon/src/main/java/com/github/appreciated/app/layout/annotations/"
    click API "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-addon/src/main/java/com/github/appreciated/app/layout/component/builder/interfaces/"
    click Resources "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-addon/src/main/resources/META-INF/resources/frontend/"
    click Build "https://github.com/appreciated/vaadin-app-layout/blob/master//app-layout-addon/pom.xml"
    click Build "https://github.com/appreciated/vaadin-app-layout/blob/master//app-layout-addon/package.json"
    click Build "https://github.com/appreciated/vaadin-app-layout/blob/master//app-layout-addon/assembly/assembly.xml"
    click Core "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-addon/"
    click ExamplesAgg "https://github.com/appreciated/vaadin-app-layout/blob/master//app-layout-examples/pom.xml"
    click Annotation "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-annotation-example/"
    click Material "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-material-theme-example/"
    click Notification "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-notification-example/"
    click Plain "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-plain-example/"
    click Profile "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-profile-example/"
    click Search "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-search-example/"
    click Spring "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-spring-example/"
    click Sticky "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-sticky-footer-example/"
    click Theme "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-examples/app-layout-theme-example/"
    click UI "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-ui-tests/"
    click UI "https://github.com/appreciated/vaadin-app-layout/blob/master//app-layout-ui-tests/pom.xml"
    click UI "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-ui-tests/src/main/java/com/github/appreciated/app/layout/test/"
    click UI "https://github.com/appreciated/vaadin-app-layout/tree/master//app-layout-ui-tests/src/test/java/com/github/appreciated/app/layout/test/"
    click Bug "https://github.com/appreciated/vaadin-app-layout/blob/master//.github/ISSUE_TEMPLATE/bug_report.md"
    click Enhancement "https://github.com/appreciated/vaadin-app-layout/blob/master//.github/ISSUE_TEMPLATE/enhancement.md"
    click Feature "https://github.com/appreciated/vaadin-app-layout/blob/master//.github/ISSUE_TEMPLATE/feature_request.md"
    click Question "https://github.com/appreciated/vaadin-app-layout/blob/master//.github/ISSUE_TEMPLATE/question.md"
```
