# badsaarow/quasar2-storybook-boilerplate architecture

> Architecture diagram of the GitHub repository badsaarow/quasar2-storybook-boilerplate, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/badsaarow/quasar2-storybook-boilerplate
- Repository: https://github.com/badsaarow/quasar2-storybook-boilerplate

## Overview

##### Main Components

A. Development Environment
- Quasar Framework (Vue 3)
- Vite Build System
- TypeScript Support
- Storybook Environment

B. Application Architecture
- Core Application
- Component Library
- State Management
- Routing System
- Internationalization (i18n)

**┌─ Development Environment ─────────────────────┐**
- ┌─────────┐ ┌──────────┐ ┌────────────────┐ │
- Vite   │ │ TypeScript│ │ DevContainer   │ │
- ┘ └──────────┘ └────────────────┘ │
- ┘

**┌─ Quasar Framework ──────────────────────────┐**
- ┌─────────┐ ┌──────────┐ ┌───────────────┐ │
- Vue 3  │ │  Router  │ │  Vuex Store   │ │
- ┘ └──────────┘ └───────────────┘ │
- ┘

**┌─ Application Components ────────────────────────────┐**
- ┌─────────┐ ┌──────────┐ ┌────────┐ ┌──────────┐  │
- Layouts │ │  Pages   │ │  i18n  │ │Components│  │
- ┘ └──────────┘ └────────┘ └──────────┘  │
- ┘

**┌─ Storybook Environment ───────────────────────┐**
- ┌───────────────┐ ┌────────────────────────┐ │
- Story Files   │ │ Component Documentation│ │
- ┘ └────────────────────────┘ │
- ┘

##### Connection Flows

- Build process flow (Vite → Application)
- Component documentation flow (Components → Storybook)
- Routing relationships (Router → Pages)
- State management flow (Store → Components)
- i18n integration (i18n → Components/Pages)

##### Important Details

A. Configuration Files:
- quasar.config.ts
- vite.config.js
- tsconfig.json
- .storybook configurations

B. Directory Structure:
- src/components
- src/pages
- src/layouts
- src/stores
- src/router
- src/i18n

C. Build & Development Tools:
- Development container setup
- CI/CD workflows
- Quality tools (ESLint, Prettier)

##### Specific Project Elements

- The boot process (src/boot)
- Asset management (src/assets)
- CSS/SCSS structure (src/css)
- Store management (src/stores)
- Component documentation flow (src/stories)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Development
        Vite["Vite Build System"]
        TypeScript["TypeScript"]
        DevContainer["Dev Container"]
        ESLint["ESLint"]
        Prettier["Prettier"]
        CICD["CI/CD Workflows"]
    end

    subgraph Framework
        Quasar["Quasar Framework"]
        Vue["Vue 3"]
        Router["Router System"]
        Store["State Management"]
    end

    subgraph Application
        App["App Entry"]
        Layouts["Layouts"]
        Pages["Pages"]
        Components["Components"]
        Boot["Boot Process"]
        I18n["Internationalization"]
        CSS["CSS/SCSS"]
        Assets["Assets"]
    end

    subgraph Storybook
        StorybookConfig["Storybook Config"]
        Stories["Story Files"]
        ButtonStory["Button Story"]
        HeaderStory["Header Story"]
        PageStory["Page Story"]
    end

    %% Relationships
    Vite --> App
    TypeScript --> App
    DevContainer --> Vite
    
    Quasar --> Vue
    Vue --> Components
    Router --> Pages
    Store --> Components
    
    Boot --> App
    I18n --> Components
    I18n --> Pages
    CSS --> Components
    Assets --> Components
    
    Components --> Stories
    Stories --> StorybookConfig
    Stories --> ButtonStory
    Stories --> HeaderStory
    Stories --> PageStory

    %% Styling
    classDef dev fill:#a8d1f0
    classDef framework fill:#90EE90
    classDef app fill:#FFB347
    classDef storybook fill:#DDA0DD

    class Vite,TypeScript,DevContainer,ESLint,Prettier,CICD dev
    class Quasar,Vue,Router,Store framework
    class App,Layouts,Pages,Components,Boot,I18n,CSS,Assets app
    class StorybookConfig,Stories,ButtonStory,HeaderStory,PageStory storybook

    %% Click events
    click Vite "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//vite.config.js"
    click TypeScript "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//tsconfig.json"
    click DevContainer "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//.devcontainer"
    click ESLint "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//.eslintrc.cjs"
    click Prettier "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//.prettierrc"
    click CICD "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//.github/workflows"
    click Quasar "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//quasar.config.ts"
    click Router "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/router"
    click Store "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/stores"
    click App "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//src/App.vue"
    click Layouts "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/layouts"
    click Pages "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/pages"
    click Components "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/components"
    click Boot "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/boot"
    click I18n "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/i18n"
    click CSS "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/css"
    click Assets "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/assets"
    click StorybookConfig "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//.storybook"
    click Stories "https://github.com/badsaarow/quasar2-storybook-boilerplate/tree/main//src/stories"
    click ButtonStory "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//src/stories/Button.stories.js"
    click HeaderStory "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//src/stories/Header.stories.js"
    click PageStory "https://github.com/badsaarow/quasar2-storybook-boilerplate/blob/main//src/stories/Page.stories.js"
```
