# yapelenua/makeyourday_fe_vue architecture

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

- Interactive diagram: https://gitdiagram.com/yapelenua/makeyourday_fe_vue
- Repository: https://github.com/yapelenua/makeyourday_fe_vue

## Overview

##### Main Components
- Frontend Application Core – Represent the Vue3 application itself including the bootstrap file (src/main.ts), which ties everything together.
- Components – Create a section for general and business logic Vue components located in src/components. Also include nested “components” directories (e.g., the components inside /src/components and the ones specifically under views such as dashboard, gallery, and kanban).
- Composables – This group (src/composables) houses reusable composition functions for form configurations, HTTP operations, global properties, and flags. Illustrate how these provide logic reuse and abstraction.
- Layouts – The project offers different Nuxt-like layouts (DefaultLayout, BlankLayout, AnimatedLayout in src/layouts) that define various page structures.
- Plugins – Note the plugins (src/plugins such as i18n, vue-global-properties, portal) which extend Vue’s capabilities and integrate third-party functionality. These should be depicted as intermediaries enhancing core behavior.
- Router – The routing system (src/router with its index, route-guard, routes, route-names) coordinates navigation and maps views to routes.
- Store – The Vuex-like state management is organized under src/store as well as per-view (dashboard, galery, kanban) local stores. This component represents application state and its management.
- Views – The “views” directory contains pages organized by functionality (auth, dashboard, galery, kanban, etc.), indicating the different screens or sections available in the app.
- Supabase Integration – Although primarily a front-end framework, the file src/supabase.ts indicates integration with Supabase as a backend service provider.
- Testing — Represent testing flows separately: include nodes that indicate both Cypress and Playwright tests under the tests folder to illustrate the E2E testing strategy.

##### Relationships and Interactions
- The main Vue instance (src/main.ts) loads and ties together plugins, router, and store which then interact with the views.
- Views get rendered using the layouts and invoke various Vue components that access state from the store and logic from composables.
- Services (like the HTTP interceptors within src/composables/http) represent intermediary calls that prepare and modify API requests; they likely service communication with external APIs (example: using the VITE_API_URL that is set in the .env file).
- Plugins (like i18n) are used by components and layouts to provide internationalization and global property access.
- The router manages navigation between pages (views) and utilizes route guards, ensuring secure access or special behavior based on user state (which is usually stored in the store).

##### Architectural Patterns and Design Principles
- Modular Structure – The project is highly modular, separating concerns between views, components, and logic (composables and store).
- Component Reusability – Emphasis on splitting business logic into separate TS files (e.g., composables and plugins) to promote reuse and maintainability.
- Separation of Concerns – Clearly divided folder structure with each folder having a distinct purpose (assets, components, views, etc.).
- Best Practices for Vue – Adheres to modern Vue3 patterns like the Composition API and scoped local registration of components.
- Testing Strategy – Integration of both Cypress and Playwright suggests a strong focus on both automated component/E2E testing.
- Use of External Tools – Tailwind CSS for styling, Supabase for backend interactions, and internationalization via i18n plugin.

##### Relevant Technologies, Frameworks, and Libraries
- Vue3 & Composition API
- Typescript (strongly-typed code in components, composables, and store)
- Vite (for bundling, as seen from vite.config.ts and related config files)
- Tailwind CSS (as referenced by tailwind configurations and examples in assets/styles)
- Testing frameworks – Cypress and Playwright
- Supabase integration (for backend services)
- i18n plugin (for internationalization support in the application)

## Diagram (Mermaid)

```mermaid
flowchart TD
    A1("Application Bootstrap (src/main.ts)"):::bootstrap
    B1("Assets & Public Resources"):::ui
    B2("Components (src/components)"):::ui
    B3("Layouts (src/layouts)"):::ui
    B4("Views (src/views)"):::ui
    C1("Composables (src/composables)"):::logic
    C2("Plugins (src/plugins)"):::logic
    C3("Router (src/router)"):::logic
    C4("Store (src/store)"):::logic
    D1("Supabase Integration (src/supabase.ts)"):::external
    E1("Testing (tests/)"):::test

    %% Core Bootstrap Relationships
    A1 -->|"loads"| C2
    A1 -->|"initializes"| C3
    A1 -->|"boots_store"| C4
    A1 -->|"bootstraps_assets"| B1

    %% Navigation and Rendering
    C3 -->|"routes_to"| B4
    B4 -->|"renders"| B2
    B4 -->|"uses"| B3

    %% Shared Logic Invocations
    B2 -->|"utilizes"| C1
    B4 -->|"invokes"| C1

    %% Plugins Enhancements
    C2 -->|"enhances"| B3
    C2 -->|"enhances"| B2

    %% External API Communication
    C1 -->|"calls_API"| D1

    %% Testing Coverage
    E1 -->|"tests"| B2
    E1 -->|"tests"| B4
    E1 -->|"tests"| C3
    E1 -->|"tests"| C4

    %% Styles
    classDef bootstrap fill:#FFD700,stroke:#000,stroke-width:2px;
    classDef ui fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef logic fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef external fill:#DDA0DD,stroke:#000,stroke-width:2px;
    classDef test fill:#FFB6C1,stroke:#000,stroke-width:2px;

    %% Click Events
    click A1 "https://github.com/yapelenua/makeyourday_fe_vue/blob/main/src/main.ts"
    click B1 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/public/"
    click B1 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/assets/"
    click B2 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/components/"
    click C1 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/composables/"
    click B3 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/layouts/"
    click C2 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/plugins/"
    click C3 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/router/"
    click C4 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/store/"
    click B4 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/src/views/"
    click D1 "https://github.com/yapelenua/makeyourday_fe_vue/blob/main/src/supabase.ts"
    click E1 "https://github.com/yapelenua/makeyourday_fe_vue/tree/main/tests/"
```
