# michaelcozzolino/flyonui-vue architecture

> Architecture diagram of the GitHub repository michaelcozzolino/flyonui-vue, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/michaelcozzolino/flyonui-vue
- Repository: https://github.com/michaelcozzolino/flyonui-vue

## Overview

##### Project type and purpose
- This is a monorepo for a Vue component library (flyonui-vue) built on top of FlyonUI and Tailwind CSS.
- It contains:
- packages/core: the Vue component library itself
- packages/create-flyonui-vue: a CLI scaffolding tool for new Vite+Vue projects that installs and configures flyonui-vue
- packages/docs: a VitePress-based documentation site showcasing components and usage
- packages/web-components: wrappers to ship the same components as framework-agnostic Web Components

##### File structure
- Top-level configuration:
- package.json, .yarnrc.yml, eslint.config.mjs, vitest.config.ts
- .github/workflows: CI definitions (node.js.yml for test/build, deploy.yml for docs or npm)
- packages/core:
- src/Components: each UI component split into Types, Internal/Lib, and UI (Vue single-file components)
- Configuration utilities under src/Configuration
- Shared code under src/Shared
- Tests in packages/core/tests
- Vite configs for building the library
- packages/create-flyonui-vue:
- src/Templates: a Vue starter template with configs and assets
- index.ts: CLI entry point
- packages/docs:
- .vitepress: site config and custom theme components
- markdown and Vue demos under packages/docs/Components, Forms, etc.
- packages/web-components:
- code to wrap core components as Web Components

##### README for additional insights
- Describes how to install and use the library in existing projects or scaffold new ones.
- Notes the dependency on FlyonUI and Tailwind CSS.

##### Elements
- Clear labels (e.g., “packages/core”, “packages/create-flyonui-vue”, “GitHub Actions”, “npm registry”)
- from monorepo root to CI workflows
- from CI workflows to documentation hosting and npm registry
- from core → docs, web-components, CLI
- from CLI → user project
- Rectangles for packages
- Parallelograms for documentation site and generated user projects
- Hexagons or diamonds for CI/CD

##### Detailed capture of essential elements
- Workspace graph: core at center feeding three consumers (docs, create CLI, web-components).
- CI workflow steps: test core, build packages, lint, deploy docs, publish packages.
- User-journey: developer runs `yarn create flyonui-vue` → CLI scaffolds a new Vite/Vue project → new project depends on flyonui-vue → project builds and runs with Tailwind CSS.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Monorepo root and CI
    root["Monorepo Root"]:::workspace
    ci["GitHub Actions"]:::ci

    %% Workspaces
    subgraph "Yarn Workspaces"
        core["packages/core"]:::package
        cli["packages/create-flyonui-vue"]:::cli
        docs["packages/docs"]:::docs
        wc["packages/web-components"]:::package
    end

    %% External services and user project
    npm["npm Registry"]:::external
    host["Docs Host (Vercel)"]:::external
    userproj["User Project"]:::external

    %% Dependencies and flows
    root --> ci
    root --> core
    root --> cli
    root --> docs
    root --> wc

    core --> docs
    core --> wc
    core --> cli

    docs --> wc

    ci --> host
    ci --> npm

    cli --> userproj
    userproj --> core

    %% Click Events for component mappings
    click root "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/package.json"
    click root "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/.yarnrc.yml"
    click root "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/eslint.config.mjs"
    click root "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/vitest.config.ts"
    click root "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/.github/workflows/node.js.yml"
    click root "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/.github/workflows/deploy.yml"

    click core "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/packages/core/package.json"
    click cli "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/packages/create-flyonui-vue/package.json"
    click docs "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/packages/docs/package.json"
    click wc "https://github.com/michaelcozzolino/flyonui-vue/blob/2.x/packages/web-components/package.json"

    %% Styles
    classDef workspace fill:#f0f8ff,stroke:#333,stroke-width:1px
    classDef package fill:#e0ffe0,stroke:#2e7d32,stroke-width:1px
    classDef cli fill:#ffe0e0,stroke:#c62828,stroke-width:1px
    classDef docs fill:#e0e0ff,stroke:#3949ab,stroke-width:1px
    classDef ci fill:#fff3e0,stroke:#ef6c00,stroke-width:1px
    classDef external fill:#f5f5f5,stroke:#616161,stroke-width:1px
```
