# manuelernestog/weektodo architecture

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

- Interactive diagram: https://gitdiagram.com/manuelernestog/weektodo
- Repository: https://github.com/manuelernestog/weektodo

## Overview

##### Main Components

a. Frontend Layer:
- Vue.js Components Structure
- Store (Vuex) Management
- Assets Management (languages, styles)
- Views/Pages Organization

b. Core Features Layer:
- Task Management System
- Storage System
- Notifications System
- Recurring Events Handler

c. Platform-Specific Layer:
- Electron Integration (for desktop)
- Web Version
- Progressive Web App Features

**┌─ Presentation Layer ─────────────────────┐**
- Vue.js Components                      │
- UI Views                              │
- Modal Systems                         │
- ┬─────────────────────┘
- ↕
**┌─ Business Layer ──────────────────────────┐**
- Vuex Store Modules                      │
- Helpers & Services                      │
- Task Management Logic                   │
- ┬──────────────────────┘
- ↕
**┌─ Data Layer ────────────────────────────┐**
- Repositories                          │
- Local Storage                         │
- Configuration Management              │
- ┘

##### Key Relationships to Highlight

a. Component Interactions:
- How Views (src/views) interact with Components (src/components)
- Store module relationships (src/store/modules)
- Repository pattern implementation (src/repositories)

b. Data Flow:
- Task creation and management flow
- Storage and persistence mechanisms
- State management through Vuex

##### Special Features to Emphasize

- Internationalization system (src/assets/languages)
- Recurring events handling (src/helpers/repeatingEvents.js)
- Notification system (src/helpers/notifications.js)
- Export/Import functionality (src/helpers/exportTool.js)

##### Implementation Details

Use these symbols and conventions:
- Double lines for API boundaries
- Diamonds for decision points
- Rectangles for components

##### Additional Recommendations

- Version information and supported platforms
- Third-party integration points
- Security and privacy features
- Configuration management flow

Remember to emphasize the local-first nature of the application and its privacy-focused architecture, as these are key differentiating features mentioned in the README.

This system design should help developers understand both the high-level architecture and the specific implementation details of WeekToDo, making it easier to maintain and extend the application.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef frontend fill:#FF9999,stroke:#333
    classDef business fill:#99FF99,stroke:#333
    classDef data fill:#9999FF,stroke:#333
    classDef platform fill:#FFCC99,stroke:#333
    classDef helper fill:#E6E6E6,stroke:#333

    %% Presentation Layer
    subgraph Presentation
        VueComponents["Vue.js Components"]
        UIViews["UI Views"]
        ModalSystems["Modal Systems"]
        TaskComponents["Task Components"]
    end

    %% Business Layer
    subgraph Business
        VuexStore["Vuex Store"]
        TaskManagement["Task Management"]
        Helpers["Helpers & Services"]
        
        subgraph StoreModules["Store Modules"]
            MainStore["Main Store"]
            ConfigStore["Config Store"]
            TodoStore["Todo Store"]
            NotifStore["Notifications Store"]
            RepeatStore["Repeating Events Store"]
        end
    end

    %% Data Layer
    subgraph Data
        LocalStorage["Local Storage"]
        Repositories["Repositories"]
        
        subgraph RepoModules["Repository Modules"]
            ConfigRepo["Config Repository"]
            DBRepo["DB Repository"]
            TodoRepo["Todo List Repository"]
            RepeatRepo["Repeating Event Repository"]
        end
    end

    %% Platform Features
    subgraph Platform
        ElectronInt["Electron Integration"]
        PWA["Progressive Web App"]
        I18n["Internationalization"]
    end

    %% Special Features
    subgraph Features
        NotifSystem["Notifications System"]
        RepeatEvents["Recurring Events Handler"]
        ExportImport["Export/Import Tool"]
    end

    %% Relationships
    VueComponents --> TaskComponents
    UIViews --> VueComponents
    TaskComponents --> TaskManagement
    TaskManagement --> VuexStore
    VuexStore --> StoreModules
    StoreModules --> Repositories
    Repositories --> RepoModules
    RepoModules --> LocalStorage
    Helpers --> NotifSystem
    Helpers --> RepeatEvents
    Helpers --> ExportImport

    %% Click Events
    click VueComponents "https://github.com/manuelernestog/weektodo/tree/main/src/components/"
    click UIViews "https://github.com/manuelernestog/weektodo/tree/main/src/views/"
    click VuexStore "https://github.com/manuelernestog/weektodo/tree/main/src/store/"
    click I18n "https://github.com/manuelernestog/weektodo/tree/main/src/assets/languages/"
    click TaskComponents "https://github.com/manuelernestog/weektodo/blob/main/src/components/toDoItem.vue"
    click NotifSystem "https://github.com/manuelernestog/weektodo/blob/main/src/helpers/notifications.js"
    click RepeatEvents "https://github.com/manuelernestog/weektodo/blob/main/src/helpers/repeatingEvents.js"
    click ElectronInt "https://github.com/manuelernestog/weektodo/blob/main/src/background.js"
    click PWA "https://github.com/manuelernestog/weektodo/blob/main/public/sw.js"
    click ExportImport "https://github.com/manuelernestog/weektodo/blob/main/src/helpers/exportTool.js"
    click ConfigRepo "https://github.com/manuelernestog/weektodo/blob/main/src/repositories/configRepository.js"
    click DBRepo "https://github.com/manuelernestog/weektodo/blob/main/src/repositories/dbRepository.js"
    click TodoRepo "https://github.com/manuelernestog/weektodo/blob/main/src/repositories/toDoListRepository.js"
    click MainStore "https://github.com/manuelernestog/weektodo/blob/main/src/store/modules/main.store.js"
    click ConfigStore "https://github.com/manuelernestog/weektodo/blob/main/src/store/modules/config.store.js"
    click TodoStore "https://github.com/manuelernestog/weektodo/blob/main/src/store/modules/todolist.store.js"
    click NotifStore "https://github.com/manuelernestog/weektodo/blob/main/src/store/modules/notifications.store.js"
    click RepeatStore "https://github.com/manuelernestog/weektodo/blob/main/src/store/modules/repeatingEvent.store.js"
    click RepeatRepo "https://github.com/manuelernestog/weektodo/blob/main/src/repositories/repeatingEventRepository.js"

    %% Style Applications
    class VueComponents,UIViews,ModalSystems,TaskComponents frontend
    class VuexStore,TaskManagement,Helpers,StoreModules business
    class LocalStorage,Repositories,RepoModules data
    class ElectronInt,PWA,I18n platform
    class NotifSystem,RepeatEvents,ExportImport helper
```
