# vanitcode/daily-lingua architecture

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

- Interactive diagram: https://gitdiagram.com/vanitcode/daily-lingua
- Repository: https://github.com/vanitcode/daily-lingua

## Overview

##### Project type and purpose
- This is a full-stack mobile application:
- Frontend: iOS app built with SwiftUI, following Clean Architecture (UI, Presentation, Domain, Data, Infrastructure).
- Backend: Firebase (Firestore, Storage, Functions) implemented in Python.
- Purpose: fetch language articles, generate AI voice audio, play it in the app, record user responses, and prepare for future analysis.

##### File structure
- Top-level directories:
- Backend/… (Firebase config, Python functions, Firestore rules)
- Daily Lingua/… (iOS app code organized by layers)
- resources/… (media, articles)
- Clean Architecture layers in iOS code:
- Composition Root (factories & DI)
- UI (SwiftUI Views)
- Presentation (ViewModels)
- Domain (Entities, Use Cases, Interfaces)
- Data (DTOs, Repositories, DataSources)
- Infrastructure (Networking, Audio, File management)
- Backend config: .firebaserc, firestore rules & indexes, firebase.json, Python venv, requirements.

##### README for insights
- It explicitly calls out each layer.
- Notes backend responsibilities: generating audio via OpenAI API, storing in Storage, writing metadata to Firestore, (future) processing user recordings and reporting.

##### Main components and their interactions
a. Frontend Components
- UI Layer (SwiftUI Views)
- Presentation Layer (ViewModels)
- Domain Layer (Use Cases, Entities, Repository Interfaces)
- Data Layer (DTOs, API DataSources, Local Cache DataSources, Mapper)
- Infrastructure Layer (URLSessionHTTPClient, AVAudioPlayerManager, AVAudioRecorderManager, FileManagerClient)
b. Backend Components
- Firestore (articles collection, audio URLs metadata)
- Storage (audio files: generated articles + user recordings)
- Firebase Functions (Python):
– Function A: listens for new articles, calls OpenAI TTS, writes audio file to Storage & URL to Firestore.
– (In-progress) Function B: processes user recordings, stores analysis/report.
- OpenAI API (external service)
c. Relationships & data flows
1. iOS app launches → Composition Root wires up layers.
2. View (UI) requests data via ViewModel → Use Case → Repository Interface → DataSource.
3. DataSource (Networking) makes HTTP/REST calls to Firestore REST API or Cloud Functions endpoints.
4. DTOs map JSON → Domain Entities → ViewModel → UI.
5. UI triggers audio playback → Infrastructure AVAudioPlayer reads from Storage URL.
6. UI triggers recording → Infrastructure AVAudioRecorder stores local file → Upload via Functions or direct Storage SDK (future).
7. Firebase Function invokes OpenAI API → Stores generated audio → Updates Firestore → App picks up new URL.
d. Architectural patterns & principles
- Clean Architecture / Hexagonal: dependency rule—outer layers depend on inner ones via interfaces.
- Dependency Injection: Composition Root builds and injects dependencies.
- Repository Pattern for data abstraction.
- Factories for use case and service instantiation.
- Layered separation: UI ↔ Presentation ↔ Domain ↔ Data ↔ Infrastructure.

## Diagram (Mermaid)

```mermaid
flowchart TB
  subgraph "iOS App"
    subgraph "Composition Root"
      CR["Composition Root"]:::frontend
    end
    subgraph "UI Layer"
      UI["UI (SwiftUI Views)"]:::frontend
    end
    subgraph "Presentation Layer"
      PRES["Presentation (ViewModels)"]:::frontend
    end
    subgraph "Domain Layer"
      ENT["Entities"]:::frontend
      INT["Interfaces (RepositoryType)"]:::frontend
      UC["Use Cases"]:::frontend
    end
    subgraph "Data Layer"
      DTO["DTOs"]:::frontend
      REP["Repositories"]:::frontend
      DSNET["Networking DataSource"]:::frontend
      DSCACHE["Cache DataSource"]:::frontend
      DSFILE["File DataSource"]:::frontend
      DSAUDIO["Audio DataSource"]:::frontend
    end
    subgraph "Infrastructure Layer"
      INET["URLSessionHTTPClient"]:::frontend
      IAUDIO["AVAudioPlayerManager / AVAudioRecorderManager"]:::frontend
      IFILE["SessionFileManagerClient"]:::frontend
    end
  end

  subgraph "Firebase Backend"
    FIRESTORE["Firestore (articles, metadata)"]:::datastore
    STORAGE["Storage (audio files)"]:::datastore
    FUNC["Firebase Functions (GenerateAudio, ProcessRecording)"]:::backend
    OPENAI["OpenAI API"]:::external
  end

  UI --> PRES
  PRES --> UC
  UC --> INT
  INT --> REP
  REP --> DSNET
  DSNET --> FIRESTORE
  UI -->|"play audio"| IAUDIO
  IAUDIO --> STORAGE
  UI -->|"record audio"| IAUDIO
  IAUDIO --> DSAUDIO
  DSAUDIO --> STORAGE
  FUNC -->|calls| OPENAI
  OPENAI --> STORAGE
  STORAGE --> FIRESTORE
  FIRESTORE --> FUNC

  click CR "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Composition Root"
  click UI "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/UI"
  click PRES "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Presentation"
  click ENT "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Domain/Entities"
  click INT "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Domain/Interfaces"
  click UC "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Domain/Use Cases"
  click DTO "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Data/DTOs"
  click REP "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Data/Repositories"
  click DSNET "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Data/Networking"
  click DSCACHE "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Data/Cache"
  click DSFILE "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Data/Files"
  click DSAUDIO "https://github.com/vanitcode/daily-lingua/tree/main/Daily Lingua/Data/Audios"
  click INET "https://github.com/vanitcode/daily-lingua/blob/main/Daily Lingua/Infrastructure/Networking/URLSessionHTTPClient.swift"
  click IAUDIO "https://github.com/vanitcode/daily-lingua/blob/main/Daily Lingua/Infrastructure/Audio/AVAudioPlayerManager.swift"
  click IFILE "https://github.com/vanitcode/daily-lingua/blob/main/Daily Lingua/Infrastructure/Files/SessionFileManagerClient.swift"
  click FUNC "https://github.com/vanitcode/daily-lingua/blob/main/Backend/functions/main.py"
  click FIRESTORE "https://github.com/vanitcode/daily-lingua/blob/main/Backend/firestore.rules"
  click STORAGE "https://github.com/vanitcode/daily-lingua/blob/main/Backend/storage.rules"

  classDef frontend fill:#ADD8E6,stroke:#0366d6,stroke-width:1px
  classDef backend fill:#98FB98,stroke:#2E8B57,stroke-width:1px
  classDef datastore fill:#D3D3D3,stroke:#696969,stroke-width:1px
  classDef external fill:#FFA500,stroke:#FF8C00,stroke-width:1px
```
