# dennislwm/playboard architecture

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

- Interactive diagram: https://gitdiagram.com/dennislwm/playboard
- Repository: https://github.com/dennislwm/playboard

## Overview

##### Main Components

a) Client Layer:
- Mobile Device (iPhone)
- Mac Workstation
- Input Methods (Bookmarklet, Email)

b) Service Layer:
- Pinboard.in (SaaS Platform)
- GitHub Actions (Automation)

c) Storage Layer:
- Pinboard.in Database
- GitHub Repository (Primary Backup)
- Local PDF Archive
- Secondary Backup (Planned)

d) Processing Components:
- RSS Feed Generator
- Recoll Search Engine (Local)
- PDF Generation Service (Planned with wkhtmltopdf)

##### Component Relationships

- User input → Pinboard.in
- Pinboard.in → RSS Feeds
- GitHub Actions → Backup Process
- RSS Feeds → PDF Generation (planned)
- PDF Files → Recoll Search Engine

##### Specific Elements

**→ Data Flow**
**⇢ Backup Flow**
- Integration

**Components:**
**□ User Interfaces**
**○ Services**
**▽ Storage**
**◇ Processing**

##### Implementation Notes

- The distributed nature of the system (mobile, web, local)
- The automation workflow through GitHub Actions
- The separation between production (Pinboard.in) and backup systems
- The local processing capabilities (Recoll, PDF generation)

##### Key Workflows to Highlight

a) Bookmark Creation Flow:
**User → (Bookmarklet/Email) → Pinboard.in → Tag-based Queues**

b) Content Consumption Flow:
**Pinboard.in → RSS Feeds → RSS Reader → User**

c) Backup Flow:
**Pinboard.in → GitHub Actions → Repository Storage**

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef ui fill:#a8d1f0,stroke:#000
    classDef service fill:#90EE90,stroke:#000
    classDef storage fill:#FFE5B4,stroke:#000
    classDef backup fill:#FFB6C1,stroke:#000
    classDef planned fill:#D3D3D3,stroke:#000,stroke-dasharray: 5 5
    
    %% Input Layer
    subgraph Input
        iPhone["iPhone"]:::ui
        Mac["Mac Workstation"]:::ui
        Bookmarklet["Bookmarklet"]:::ui
        Email["Email Input"]:::ui
    end

    %% Service Layer
    subgraph Services
        Pinboard["Pinboard.in"]:::service
        GHActions["GitHub Actions"]:::service
        click GHActions "https://github.com/dennislwm/playboard/blob/main/.github/workflows/main.yml"
    end

    %% Processing Layer
    subgraph Processing
        RSS["RSS Feed Generator"]:::service
        Recoll["Recoll Search Engine"]:::service
        PDFGen["PDF Generation Service"]:::planned
    end

    %% Storage Layer
    subgraph Storage
        PinboardDB["Pinboard.in DB"]:::storage
        GitRepo["GitHub Repository"]:::backup
        click GitRepo "https://github.com/dennislwm/playboard/blob/main/api/bookmarks.json"
        PDFArchive["Local PDF Archive"]:::storage
        SecBackup["Secondary Backup"]:::planned
    end

    %% Relationships
    iPhone --> Pinboard
    Mac --> Pinboard
    Bookmarklet --> Pinboard
    Email --> Pinboard
    
    Pinboard --> RSS
    Pinboard --> GHActions
    
    GHActions --> GitRepo
    RSS --> PDFGen
    PDFGen --> PDFArchive
    PDFArchive --> Recoll
    
    PinboardDB --> GHActions
    GitRepo -.-> SecBackup
    
    %% Legend
    subgraph Legend
        UI["User Interface"]:::ui
        SVC["Service"]:::service
        STR["Storage"]:::storage
        BKP["Backup"]:::backup
        PLN["Planned"]:::planned
    end
```
