# winmatwey/spotbrief architecture

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

- Interactive diagram: https://gitdiagram.com/winmatwey/spotbrief
- Repository: https://github.com/winmatwey/spotbrief

## Overview

SpotBrief is a dual-platform news reader: users receive regional or custom RSS news, browse categorized articles, search and save them, and can listen to offline summaries. The README documents aggregation, filtering, categorization, summarization, speech, settings, widgets, and notifications, but the supplied tree contains no source directories or excerpts. Accordingly, feature nodes have no implementation paths; edges reflect documented behavior only, not inspected call sites.

Main entry points: [`SpotBrief.apk`](https://github.com/winmatwey/spotbrief/blob/main/SpotBrief.apk) (Android app), [`SpotBrief.ipa`](https://github.com/winmatwey/spotbrief/blob/main/SpotBrief.ipa) (iOS app)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_apps["Mobile apps"]
  node_ios["iOS app<br/>[SpotBrief.ipa]"]
  node_android["Android app<br/>[SpotBrief.apk]"]
end

subgraph group_news["News processing"]
  node_aggregation["Feed aggregation"]
  node_availability["Feed availability"]
  node_filter["News filtering"]
  node_categories["Categorization"]
  node_summaries["Offline summaries"]
end

subgraph group_reader["Reading features"]
  node_search["Article search"]
  node_bookmarks[("Bookmarks history")]
  node_custom["Custom sources"]
  node_settings["Settings languages"]
end

subgraph group_platform["Device services"]
  node_speech["Text to speech"]
  node_widget["Daily digest widget"]
  node_notifications["Morning alerts"]
end

node_user(("Reader"))
node_feeds["RSS feeds"]
node_system_speech["System speech"]

node_user -->|"uses"| node_ios
node_user -->|"uses"| node_android
node_ios -->|"fetches news"| node_aggregation
node_android -->|"fetches news"| node_aggregation
node_aggregation -->|"fetches feeds"| node_feeds
node_ios -->|"checks feeds"| node_availability
node_android -->|"checks feeds"| node_availability
node_ios -->|"filters articles"| node_filter
node_android -->|"filters articles"| node_filter
node_ios -->|"categorizes news"| node_categories
node_android -->|"categorizes news"| node_categories
node_ios -->|"summarizes offline"| node_summaries
node_android -->|"summarizes offline"| node_summaries
node_ios -->|"searches articles"| node_search
node_android -->|"searches articles"| node_search
node_ios -->|"tracks reading"| node_bookmarks
node_android -->|"tracks reading"| node_bookmarks
node_ios -->|"adds feeds"| node_custom
node_android -->|"adds feeds"| node_custom
node_ios -->|"supports languages"| node_settings
node_android -->|"supports languages"| node_settings
node_ios -->|"reads summaries"| node_speech
node_android -->|"reads summaries"| node_speech
node_speech -->|"uses synthesizer"| node_system_speech
node_android -->|"provides digest"| node_widget
node_android -->|"schedules alerts"| node_notifications
node_ios -->|"schedules alerts"| node_notifications

click node_ios "https://github.com/winmatwey/spotbrief/blob/main/SpotBrief.ipa"
click node_android "https://github.com/winmatwey/spotbrief/blob/main/SpotBrief.apk"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ios,node_android toneBlue
class node_aggregation,node_availability,node_filter,node_categories,node_summaries toneAmber
class node_search,node_bookmarks,node_custom,node_settings toneMint
class node_speech,node_widget,node_notifications toneRose
class node_user,node_feeds,node_system_speech toneIndigo
```

## Components

### Mobile apps

- [iOS app](https://github.com/winmatwey/spotbrief/blob/main/SpotBrief.ipa): `SpotBrief.ipa`
- [Android app](https://github.com/winmatwey/spotbrief/blob/main/SpotBrief.apk): `SpotBrief.apk`

### News processing

- **Feed aggregation**
- **Feed availability**
- **News filtering**
- **Categorization**
- **Offline summaries**

### Reading features

- **Article search**
- **Bookmarks history**
- **Custom sources**
- **Settings languages**

### Device services

- **Text to speech**
- **Daily digest widget**
- **Morning alerts**

### Other components

- **Reader**
- **RSS feeds**
- **System speech**

## Connections

- Reader → iOS app: uses (evidence: `README.md`)
- Reader → Android app: uses (evidence: `README.md`)
- iOS app → Feed aggregation: fetches news (evidence: `README.md`)
- Android app → Feed aggregation: fetches news (evidence: `README.md`)
- Feed aggregation → RSS feeds: fetches feeds (evidence: `README.md`)
- iOS app → Feed availability: checks feeds (evidence: `README.md`)
- Android app → Feed availability: checks feeds (evidence: `README.md`)
- iOS app → News filtering: filters articles (evidence: `README.md`)
- Android app → News filtering: filters articles (evidence: `README.md`)
- iOS app → Categorization: categorizes news (evidence: `README.md`)
- Android app → Categorization: categorizes news (evidence: `README.md`)
- iOS app → Offline summaries: summarizes offline (evidence: `README.md`)
- Android app → Offline summaries: summarizes offline (evidence: `README.md`)
- iOS app → Article search: searches articles (evidence: `README.md`)
- Android app → Article search: searches articles (evidence: `README.md`)
- iOS app → Bookmarks history: tracks reading (evidence: `README.md`)
- Android app → Bookmarks history: tracks reading (evidence: `README.md`)
- iOS app → Custom sources: adds feeds (evidence: `README.md`)
- Android app → Custom sources: adds feeds (evidence: `README.md`)
- iOS app → Settings languages: supports languages (evidence: `README.md`)
- Android app → Settings languages: supports languages (evidence: `README.md`)
- iOS app → Text to speech: reads summaries (evidence: `README.md`)
- Android app → Text to speech: reads summaries (evidence: `README.md`)
- Text to speech → System speech: uses synthesizer (evidence: `README.md`)
- Android app → Daily digest widget: provides digest (evidence: `README.md`)
- Android app → Morning alerts: schedules alerts (evidence: `README.md`)
- iOS app → Morning alerts: schedules alerts (evidence: `README.md`)
