# vickydarlinn/pookie_shoppe_admin_ui architecture

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

- Interactive diagram: https://gitdiagram.com/vickydarlinn/pookie_shoppe_admin_ui
- Repository: https://github.com/vickydarlinn/pookie_shoppe_admin_ui

## Overview

##### Main Components
- Entry Point & Build Configuration:
- Vite configuration (vite.config.ts, tsconfig.json files, etc.) and index.html.
- The application entry (src/main.tsx) that bootstraps the app.
- Application Core Structure:
- Pages: Different application views like HomePage, LoginPage, CategoryPage, RestaurantPage, ProductPage, UsersPage.
- Layouts: Structures wrapping pages (e.g., Root, NonAuth, Dashboard, AdminAccess). These determine how the UI is structured for different parts of the application.
- Components: Reusable UI components including breadcrumbs, headers, sidebars, drawers, tables, and various UI elements.
- Business Logic & State Management:
- Hooks: Custom React hooks (for categories, restaurants, users, login/logout, etc.) encapsulating business logic and API interactions.
- Store: Contains state management (useAuthStore and useThemeStore) which likely support global state across the app.
- APIs & Utilities:
- API modules in src/apis that abstract communication with backend services.
- Utility functions (src/lib/utils.ts, src/utils/*) for shared helper code.
- Styling & Configuration:
- Tailwind & PostCSS configurations for styling.
- ESLint configurations to enforce coding standards.

##### Relationships and Interactions
- The main front-end “shell” (App.tsx) incorporates routing (using src/router.tsx) which directs the user to views (pages) based on navigation.
- Layout components wrap individual page components, facilitating different access levels (authenticated vs. non-authenticated, admin access, etc.).
- Individual pages assemble various UI components to construct functional views.
- Custom hooks manage CRUD operations for categories, restaurants, and users – typically yielding side effects such as fetching data or mutations.
- APIs are called through the hooks to interact with external backend services.
- The state management components (store) maintain global state like authentication status and theme details, which subsequent hooks and components consume.

##### Architectural Patterns & Principles
- Component Reusability: Clear separation of UI components, enabling reusability across various pages and layouts.
- Separation of Concerns: Distinct folders for routing, API interactions, UI elements, and state management, aligning with best practices.
- Modular Architecture: Features and business logic are organized into relevant directories (e.g., pages, hooks, store) ensuring scalability.

##### Final Advice for the Principal Software Engineer
- API and store layers to show how pages and components fetch data and manage state.
- Incorporate every detail provided by the structure: list each major directory and its role, such as “src/apis”, “src/hooks”, “src/store”, and “src/components/ui”.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & Configuration Layer
    subgraph "Build & Configuration"
        E1("Main Entry (src/main.tsx)"):::build
        E2("HTML Template (index.html)"):::build
        E3("Vite Config (vite.config.ts)"):::build
    end

    %% Router Layer
    subgraph "Routing"
        R("Router (src/router.tsx)"):::router
    end

    %% Layouts Layer
    subgraph "Layouts"
        L1("Root Layout"):::layout
        L2("NonAuth Layout"):::layout
        L3("Dashboard Layout"):::layout
        L4("AdminAccess Layout"):::layout
    end

    %% Pages Layer
    subgraph "Pages"
        P1("Home Page"):::page
        P2("Login Page"):::page
        P3("Category Page"):::page
        P4("Restaurant Page"):::page
        P5("Product Page"):::page
        P6("Users Page"):::page
    end

    %% UI Components Layer
    subgraph "UI Components"
        C1("Breadcrumb"):::component
        C2("Header"):::component
        C3("SideBar"):::component
        C4("Drawer"):::component
        C5("Table"):::component
        C6("Other UI Elements"):::component
    end

    %% Business Logic & Hooks Layer
    subgraph "Business Logic & Hooks"
        H1("Category Hooks"):::hook
        H2("Restaurant Hooks"):::hook
        H3("User Hooks"):::hook
        H4("Authentication Hooks"):::hook
        H5("Additional Hooks"):::hook
    end

    %% State Management Layer
    subgraph "State Management"
        S("Global Store"):::store
    end

    %% APIs & Utilities Layer
    subgraph "APIs & Utilities"
        A("API Modules"):::api
        U1("Shared Utilities"):::api
        U2("Other Helpers"):::api
    end

    %% Connections
    E1 -->|"bootstraps"| R
    R -->|"routes to"| L1
    R -->|"routes to"| L2
    R -->|"routes to"| L3
    R -->|"routes to"| L4

    L1 -->|"wraps"| P1
    L1 -->|"wraps"| P2
    L2 -->|"wraps"| P3
    L3 -->|"wraps"| P4
    L4 -->|"wraps"| P5
    L4 -->|"wraps"| P6

    P1 -->|"renders"| C1
    P1 -->|"renders"| C2
    P2 -->|"renders"| C3
    P3 -->|"renders"| C4
    P4 -->|"renders"| C5
    P5 -->|"renders"| C6

    P1 -->|"calls"| H1
    P2 -->|"calls"| H4
    P3 -->|"calls"| H1
    P4 -->|"calls"| H2
    P5 -->|"calls"| H3
    P6 -->|"calls"| H5

    H1 -->|"invokes"| A
    H2 -->|"invokes"| A
    H3 -->|"invokes"| A
    H4 -->|"invokes"| A
    H5 -->|"invokes"| A

    H1 -->|"updates"| S
    H2 -->|"updates"| S
    H3 -->|"updates"| S
    H4 -->|"updates"| S
    H5 -->|"updates"| S

    U1 -->|"supports"| A
    U2 -->|"supports"| A

    %% Click Events
    click E1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/main.tsx"
    click E2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/index.html"
    click E3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/vite.config.ts"
    click R "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/router.tsx"

    click P1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/homePage/HomePage.tsx"
    click P1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/homePage/index.tsx"
    click P2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/loginPage/LoginPage.tsx"
    click P2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/loginPage/index.tsx"
    click P3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/categoryPage/CategoryPage.tsx"
    click P3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/categoryPage/index.tsx"
    click P4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/restaurantPage/RestaurantPage.tsx"
    click P4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/restaurantPage/index.ts"
    click P5 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/productPage/ProductPage.tsx"
    click P5 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/productPage/index.tsx"
    click P6 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/usersPage/UsersPage.tsx"
    click P6 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/pages/usersPage/index.tsx"

    click L1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/root/Root.tsx"
    click L1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/root/index.tsx"
    click L2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/nonAuth/NonAuth.tsx"
    click L2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/nonAuth/index.tsx"
    click L3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/dashboard/Dashboard.tsx"
    click L3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/dashboard/index.tsx"
    click L4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/adminAccess/AdminAccess.tsx"
    click L4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/layouts/adminAccess/index.tsx"

    click C1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/breadcrumb/Breadcrumb.tsx"
    click C1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/breadcrumb/index.tsx"
    click C1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/ui/breadcrumb.tsx"
    click C2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/header/Header.tsx"
    click C2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/header/index.tsx"
    click C3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/sideBar/SideBar.tsx"
    click C3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/sideBar/index.tsx"
    click C4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/drawer/Drawer.tsx"
    click C4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/drawer/index.tsx"
    click C5 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/table/Table.tsx"
    click C5 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/components/table/index.tsx"
    click C6 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/components/ui"

    click H1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/hooks/categories"
    click H2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/hooks/restaurants"
    click H3 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/hooks/users"
    click H4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/hooks/useLoginMutation.ts"
    click H4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/hooks/useLogoutMutation.ts"
    click H4 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/hooks/userSelfQuery.ts"
    click H5 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/hooks/use-mobile.tsx"

    click S "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/store"

    click A "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/apis"
    click U1 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/blob/main/src/lib/utils.ts"
    click U2 "https://github.com/vickydarlinn/pookie_shoppe_admin_ui/tree/main/src/utils"

    %% Styles
    classDef build fill:#cce5ff,stroke:#004085,stroke-width:2px;
    classDef router fill:#d1ecf1,stroke:#0c5460,stroke-width:2px;
    classDef layout fill:#d4edda,stroke:#155724,stroke-width:2px;
    classDef page fill:#f8d7da,stroke:#721c24,stroke-width:2px;
    classDef component fill:#fff3cd,stroke:#856404,stroke-width:2px;
    classDef hook fill:#ffeeba,stroke:#856404,stroke-width:2px;
    classDef store fill:#c3e6cb,stroke:#155724,stroke-width:2px;
    classDef api fill:#d6d8d9,stroke:#41464b,stroke-width:2px;
```
