# yuna9068/kanban-task-management architecture

> Architecture diagram of the GitHub repository yuna9068/kanban-task-management, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yuna9068/kanban-task-management
- Repository: https://github.com/yuna9068/kanban-task-management

## Overview

##### Project type and purpose
- This is a Vue 3/Nuxt 3 single-page application (SPA) implementing a Kanban board UI.
- There is no separate backend service—data is read/written to localStorage in the browser.
- The app is statically generated or hosted (e.g. GitHub Pages) via a CI/CD workflow.

##### Major architectural components
a. Hosting & Delivery
– Repository on GitHub
– GitHub Actions workflow (.github/workflows/deploy.yml) for build & deploy
– Static host (e.g. GitHub Pages or any CDN) serving JS/CSS/assets
b. Client (Browser)
– Nuxt 3 “app” shell
– Vue Router (pages/index.vue, pages/about.vue => route components)
– Pinia stores (stores/alert.ts, board.ts, sidebar.ts, task.ts) for global state
– Composables (composables/useDevice.ts) for reusable logic
– UI Components (components/base, components/board, components/task, components/sidebar, components/header)
– 3rd-party libraries: VueUse, VueDraggablePlus, nuxt-svgo, Google Fonts module, ESLint config
c. Persistence
– Browser localStorage for CRUD of boards/tasks/subtasks
d. User Device
– Desktop or mobile browser consuming the SPA

##### Interactions & Data Flow
- User → Browser UI → Vue components → Pinia store → localStorage (persist)
- On page load: store reads from localStorage → hydrates initial state → UI renders
- Drag-and-drop events (VueDraggablePlus) update store → UI re-orders items → store writes back
- Theme switcher toggles a CSS class on <body> using a composable → persists theme in store/localStorage

##### Architectural patterns & design principles
- Component-based hierarchy (Base*, Board*, Task*, Sidebar*, Header* folders)
- Directory-based routing (Nuxt pages directory)
- Composables for cross-component logic (device detection, alerts)
- Centralized state with Pinia stores
- SCSS partials and variables for theming and responsive design
- Static generation / SSG approach—no dynamic server API

##### Technologies & frameworks
- Nuxt 3 (Vue 3, Vue Router 4)
- Pinia 2 for state management
- SCSS for styling (with mixins & variables)
- VueUse for utility composables
- VueDraggablePlus for drag-and-drop
- GitHub Actions for CI/CD
- GitHub Pages / CDN for static hosting

## Diagram (Mermaid)

```mermaid
flowchart TD
  classDef infra fill:#eeeeee,stroke:#333;
  classDef presentation fill:#bbdefb,stroke:#333;
  classDef state fill:#c8e6c9,stroke:#333;
  classDef persistence fill:#ffe0b2,stroke:#333;
  classDef external fill:#dddddd,stroke:#333;

  GitHubRepo["GitHub Repo"]:::infra
  GitHubActions["GitHub Actions Workflow"]:::infra
  StaticHost["Static Host / CDN"]:::infra

  GitHubRepo -->|"CI/CD"| GitHubActions
  GitHubActions -->|"Deploy"| StaticHost

  subgraph "Client (Browser)"
    direction TB

    AppShell["Nuxt Shell: app.vue"]:::state
    NuxtConfig["Nuxt Config: nuxt.config.ts"]:::state

    StaticHost -->|"Loads SPA"| AppShell
    AppShell --> NuxtConfig

    User["User"]:::external
    User -->|"interacts"| VueRouter

    subgraph "Routing Layer"
      direction TB
      VueRouter["Vue Router"]:::presentation
      PagesIndex["pages/index.vue"]:::presentation
      PagesAbout["pages/about.vue"]:::presentation
      VueRouter --> PagesIndex
      VueRouter --> PagesAbout
    end

    subgraph "UI Layer"
      direction TB
      subgraph "Base Components"
        BCheckbox["BaseCheckbox.vue"]:::presentation
        BDropdown["BaseDropdown.vue"]:::presentation
        BFormItem["BaseFormItem.vue"]:::presentation
        BInput["BaseInput.vue"]:::presentation
        BModal["BaseModal.vue"]:::presentation
        BModalAlert["BaseModalAlert.vue"]:::presentation
        BSelect["BaseSelect.vue"]:::presentation
        BTextarea["BaseTextarea.vue"]:::presentation
      end
      subgraph "Board Components"
        BoardColumn["BoardColumn.vue"]:::presentation
        BoardColumnEmpty["BoardColumnEmpty.vue"]:::presentation
        BoardEmpty["BoardEmpty.vue"]:::presentation
        BoardIndex["BoardIndex.vue"]:::presentation
        BoardLoading["BoardLoading.vue"]:::presentation
        BoardModal["BoardModal.vue"]:::presentation
      end
      subgraph "Header Components"
        HeaderIndex["HeaderIndex.vue"]:::presentation
        HeaderLogo["HeaderLogo.vue"]:::presentation
        HeaderMain["HeaderMain.vue"]:::presentation
      end
      subgraph "Sidebar Components"
        SidebarBoard["SidebarBoard.vue"]:::presentation
        SidebarIndex["SidebarIndex.vue"]:::presentation
        SidebarLink["SidebarLink.vue"]:::presentation
        SidebarSwitcher["SidebarSwitcher.vue"]:::presentation
        SidebarThemeSwitcher["SidebarThemeSwitcher.vue"]:::presentation
      end
      subgraph "Task Components"
        TaskCard["TaskCard.vue"]:::presentation
        TaskDetail["TaskDetailModal.vue"]:::presentation
        TaskEdit["TaskEditModal.vue"]:::presentation
      end
    end

    subgraph "State Layer"
      direction TB
      StoreAlert["Pinia Store: alert.ts"]:::state
      StoreBoard["Pinia Store: board.ts"]:::state
      StoreSidebar["Pinia Store: sidebar.ts"]:::state
      StoreTask["Pinia Store: task.ts"]:::state
      ComposableDevice["Composable: useDevice.ts"]:::state
    end

    subgraph "Persistence Layer"
      direction TB
      LocalStorage["localStorage"]:::persistence
    end

    subgraph "External Libraries"
      direction TB
      VueUse["VueUse"]:::external
      Draggable["VueDraggablePlus"]:::external
    end

    VueRouter --> UI
    VueRouter --> BCheckbox

    BCheckbox --> StoreBoard
    BDropdown --> StoreBoard
    BFormItem --> StoreBoard
    BInput --> StoreTask
    BModal --> StoreTask
    BModalAlert --> StoreAlert
    BSelect --> StoreTask
    BTextarea --> StoreTask

    BoardColumn --> StoreBoard
    BoardColumnEmpty --> StoreBoard
    BoardEmpty --> StoreBoard
    BoardIndex --> StoreBoard
    BoardLoading --> StoreBoard
    BoardModal --> StoreBoard

    HeaderIndex --> StoreSidebar
    HeaderLogo --> StoreSidebar
    HeaderMain --> StoreSidebar

    SidebarBoard --> StoreSidebar
    SidebarIndex --> StoreSidebar
    SidebarLink --> StoreSidebar
    SidebarSwitcher --> StoreSidebar
    SidebarThemeSwitcher --> StoreSidebar

    TaskCard --> StoreTask
    TaskDetail --> StoreTask
    TaskEdit --> StoreTask

    StoreBoard -->|"read/write"| LocalStorage
    StoreTask -->|"read/write"| LocalStorage
    StoreSidebar -->|"read/write"| LocalStorage
    StoreAlert -->|"read/write"| LocalStorage

    LocalStorage -->|"hydrate"| StoreBoard
    LocalStorage -->|"hydrate"| StoreTask
    LocalStorage -->|"hydrate"| StoreSidebar
    LocalStorage -->|"hydrate"| StoreAlert

    ComposableDevice --> BCheckbox
    ComposableDevice --> HeaderMain

    VueUse --> ComposableDevice
    Draggable --> TaskCard
    Draggable --> BoardColumn
  end

  click GitHubActions "https://github.com/yuna9068/kanban-task-management/blob/main/.github/workflows/deploy.yml"
  click AppShell "https://github.com/yuna9068/kanban-task-management/blob/main/app.vue"
  click NuxtConfig "https://github.com/yuna9068/kanban-task-management/blob/main/nuxt.config.ts"
  click PagesIndex "https://github.com/yuna9068/kanban-task-management/blob/main/pages/index.vue"
  click PagesAbout "https://github.com/yuna9068/kanban-task-management/blob/main/pages/about.vue"
  click StoreAlert "https://github.com/yuna9068/kanban-task-management/blob/main/stores/alert.ts"
  click StoreBoard "https://github.com/yuna9068/kanban-task-management/blob/main/stores/board.ts"
  click StoreSidebar "https://github.com/yuna9068/kanban-task-management/blob/main/stores/sidebar.ts"
  click StoreTask "https://github.com/yuna9068/kanban-task-management/blob/main/stores/task.ts"
  click ComposableDevice "https://github.com/yuna9068/kanban-task-management/blob/main/composables/useDevice.ts"
  click BCheckbox "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseCheckbox.vue"
  click BDropdown "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseDropdown.vue"
  click BFormItem "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseFormItem.vue"
  click BInput "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseInput.vue"
  click BModal "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseModal.vue"
  click BModalAlert "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseModalAlert.vue"
  click BSelect "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseSelect.vue"
  click BTextarea "https://github.com/yuna9068/kanban-task-management/blob/main/components/base/BaseTextarea.vue"
  click BoardColumn "https://github.com/yuna9068/kanban-task-management/blob/main/components/board/BoardColumn.vue"
  click BoardColumnEmpty "https://github.com/yuna9068/kanban-task-management/blob/main/components/board/BoardColumnEmpty.vue"
  click BoardEmpty "https://github.com/yuna9068/kanban-task-management/blob/main/components/board/BoardEmpty.vue"
  click BoardIndex "https://github.com/yuna9068/kanban-task-management/blob/main/components/board/BoardIndex.vue"
  click BoardLoading "https://github.com/yuna9068/kanban-task-management/blob/main/components/board/BoardLoading.vue"
  click BoardModal "https://github.com/yuna9068/kanban-task-management/blob/main/components/board/BoardModal.vue"
  click HeaderIndex "https://github.com/yuna9068/kanban-task-management/blob/main/components/header/HeaderIndex.vue"
  click HeaderLogo "https://github.com/yuna9068/kanban-task-management/blob/main/components/header/HeaderLogo.vue"
  click HeaderMain "https://github.com/yuna9068/kanban-task-management/blob/main/components/header/HeaderMain.vue"
  click SidebarBoard "https://github.com/yuna9068/kanban-task-management/blob/main/components/sidebar/SidebarBoard.vue"
  click SidebarIndex "https://github.com/yuna9068/kanban-task-management/blob/main/components/sidebar/SidebarIndex.vue"
  click SidebarLink "https://github.com/yuna9068/kanban-task-management/blob/main/components/sidebar/SidebarLink.vue"
  click SidebarSwitcher "https://github.com/yuna9068/kanban-task-management/blob/main/components/sidebar/SidebarSwitcher.vue"
  click SidebarThemeSwitcher "https://github.com/yuna9068/kanban-task-management/blob/main/components/sidebar/SidebarThemeSwitcher.vue"
  click TaskCard "https://github.com/yuna9068/kanban-task-management/blob/main/components/task/TaskCard.vue"
  click TaskDetail "https://github.com/yuna9068/kanban-task-management/blob/main/components/task/TaskDetailModal.vue"
  click TaskEdit "https://github.com/yuna9068/kanban-task-management/blob/main/components/task/TaskEditModal.vue"
```
