# epicmaxco/vuestic-admin architecture

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

- Interactive diagram: https://gitdiagram.com/epicmaxco/vuestic-admin
- Repository: https://github.com/epicmaxco/vuestic-admin

## Overview

##### Main Components Identification

The system should be represented with these key components:

a) Frontend Architecture (Core):
- Vue 3 Application Layer
- Vuestic UI Component Library
- State Management (Pinia Stores)
- Routing System
- i18n Internationalization

b) Feature Modules:
- Authentication System
- Dashboard
- User Management
- Project Management
- Billing & Payments
- Settings & Preferences

**[Client Browser] → [Frontend Application]**
- [Core Services]
- Router
- State Management
- i18n Service
- API Service

- [Layout Components]
- App Layout
- Auth Layout
- Navigation

- [Feature Modules]
- Dashboard
- Users
- Projects
- Billing
- Settings

- [Shared Components]
- Charts
- UI Components

##### Important Relationships to Highlight

- How Pinia stores (found in /src/stores) interact with different components
- Routing system's connection to feature modules
- Demonstrate how shared components are utilized across feature modules
- I18n service's integration with the UI components

##### Technical Stack Indicators

A tech stack section showing:
- Vue 3
- Vite
- Pinia
- Tailwind CSS
- Vuestic UI
- TypeScript

##### Implementation Details

- Maintain a clean, hierarchical layout
- Brief descriptions for major components
- Version numbers for key dependencies

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        Browser["Web Browser"]
    end

    subgraph "Frontend Application"
        App["Vue Application Core"]:::core
        click App "https://github.com/epicmaxco/vuestic-admin/blob/master/src/App.vue"

        subgraph "Core Services"
            Router["Routing System"]:::service
            click Router "https://github.com/epicmaxco/vuestic-admin/blob/master/src/router/index.ts"
            StateManagement["State Management"]:::service
            click StateManagement "https://github.com/epicmaxco/vuestic-admin/tree/master/src/stores/"
            i18n["i18n Service"]:::service
            click i18n "https://github.com/epicmaxco/vuestic-admin/blob/master/src/i18n/index.ts"
            APIService["API Service"]:::service
            click APIService "https://github.com/epicmaxco/vuestic-admin/blob/master/src/services/api.ts"
            UIConfig["UI Configuration"]:::service
            click UIConfig "https://github.com/epicmaxco/vuestic-admin/tree/master/src/services/vuestic-ui/"
        end

        subgraph "Layout Components"
            AppLayout["App Layout"]:::layout
            click AppLayout "https://github.com/epicmaxco/vuestic-admin/blob/master/src/layouts/AppLayout.vue"
            AuthLayout["Auth Layout"]:::layout
            click AuthLayout "https://github.com/epicmaxco/vuestic-admin/blob/master/src/layouts/AuthLayout.vue"
            Navigation["Navigation"]:::layout
            click Navigation "https://github.com/epicmaxco/vuestic-admin/tree/master/src/components/app-layout-navigation/"
        end

        subgraph "Feature Modules"
            Dashboard["Dashboard"]:::feature
            click Dashboard "https://github.com/epicmaxco/vuestic-admin/tree/master/src/pages/admin/dashboard/"
            Users["User Management"]:::feature
            click Users "https://github.com/epicmaxco/vuestic-admin/tree/master/src/pages/users/"
            Projects["Project Management"]:::feature
            click Projects "https://github.com/epicmaxco/vuestic-admin/tree/master/src/pages/projects/"
            Billing["Billing & Payments"]:::feature
            click Billing "https://github.com/epicmaxco/vuestic-admin/tree/master/src/pages/billing/"
            Settings["Settings & Preferences"]:::feature
            click Settings "https://github.com/epicmaxco/vuestic-admin/tree/master/src/pages/settings/"
            Auth["Authentication"]:::feature
            click Auth "https://github.com/epicmaxco/vuestic-admin/tree/master/src/pages/auth/"
        end

        subgraph "Shared Components"
            Charts["Charts"]:::shared
            click Charts "https://github.com/epicmaxco/vuestic-admin/tree/master/src/components/va-charts/"
            Icons["Icons"]:::shared
            click Icons "https://github.com/epicmaxco/vuestic-admin/tree/master/src/components/icons/"
            Navbar["Navbar"]:::shared
            click Navbar "https://github.com/epicmaxco/vuestic-admin/tree/master/src/components/navbar/"
            Sidebar["Sidebar"]:::shared
            click Sidebar "https://github.com/epicmaxco/vuestic-admin/tree/master/src/components/sidebar/"
        end

        subgraph "Data Layer"
            ChartData["Chart Data"]:::data
            click ChartData "https://github.com/epicmaxco/vuestic-admin/tree/master/src/data/charts/"
            UserData["User Data"]:::data
            click UserData "https://github.com/epicmaxco/vuestic-admin/blob/master/src/data/users.json"
            ProjectData["Project Data"]:::data
            click ProjectData "https://github.com/epicmaxco/vuestic-admin/blob/master/src/data/pages/projects-db.json"
        end

        subgraph "Stores"
            GlobalStore["Global Store"]:::store
            click GlobalStore "https://github.com/epicmaxco/vuestic-admin/blob/master/src/stores/global-store.ts"
            UserStore["User Store"]:::store
            click UserStore "https://github.com/epicmaxco/vuestic-admin/blob/master/src/stores/user-store.ts"
            ProjectStore["Project Store"]:::store
            click ProjectStore "https://github.com/epicmaxco/vuestic-admin/blob/master/src/stores/projects.ts"
        end
    end

    %% Relationships
    Browser --> App
    App --> Router
    App --> StateManagement
    App --> i18n
    App --> APIService
    App --> UIConfig

    Router --> AppLayout
    Router --> AuthLayout
    AppLayout --> Navigation
    Navigation --> Navbar
    Navigation --> Sidebar

    StateManagement --> GlobalStore
    StateManagement --> UserStore
    StateManagement --> ProjectStore

    %% Feature Module Dependencies
    Dashboard --> Charts
    Dashboard --> ChartData
    Users --> UserData
    Projects --> ProjectData
    
    %% Styling
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef service fill:#FF9800,stroke:#F57C00,color:white
    classDef layout fill:#4CAF50,stroke:#388E3C,color:white
    classDef feature fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef shared fill:#607D8B,stroke:#455A64,color:white
    classDef store fill:#E91E63,stroke:#C2185B,color:white
    classDef data fill:#795548,stroke:#5D4037,color:white

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Services"]:::service
        L3["Layout Components"]:::layout
        L4["Feature Modules"]:::feature
        L5["Shared Components"]:::shared
        L6["Stores"]:::store
        L7["Data Sources"]:::data
    end
```
