How vanitcode/daily-lingua works
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.