# wikimedia/apps-android-wikipedia architecture

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

- Interactive diagram: https://gitdiagram.com/wikimedia/apps-android-wikipedia
- Repository: https://github.com/wikimedia/apps-android-wikipedia

## Overview

##### Main Components

a. Client-Side Components:
- UI Layer
- Activities and Fragments (in /app/src/main/java/org/wikipedia/)
- Views and Adapters
- ViewModels (following MVVM pattern)
- Data Layer
- Local Database (Room - indicated by AppDatabase.kt)
- Cache Management
- Offline Storage
- Network Layer
- API Clients (RestService, CoreRestService)
- Authentication
- Image Loading

b. External Services:
- Wikipedia API
- MediaWiki Services
- Firebase Services (indicated by google-services.json)
- Analytics Platform

##### Architecture Patterns to Highlight

- MVVM Architecture (evident from *ViewModel.kt files)
- Repository Pattern (seen in various repository implementations)
- Clean Architecture principles (separation of concerns in package structure)

##### Key Relationships

Data flow between:
- UI Components → ViewModels → Repositories
- Repositories → Local Database/Network Services
- Offline/Online data synchronization paths
- Authentication flow

##### Specific Implementation Details

Specialized features:
- Feed System (feed package)
- Search functionality
- Page rendering
- Edit capabilities
- Reading lists
- Notifications system

**┌─────────────────────────────────────────┐**
- Presentation Layer                      │
- (Activities, Fragments, Views)          │
- ┤
- Business Logic Layer                    │
- (ViewModels, Use Cases)                 │
- ┤
- Data Layer                              │
- (Repositories, Local DB, Network)       │
- ┤
- External Services                       │
- (Wikipedia API, Firebase, etc.)         │
- ┘

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and classes
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef business fill:#2ecc71,stroke:#27ae60,color:white
    classDef data fill:#f1c40f,stroke:#f39c12,color:black
    classDef network fill:#e74c3c,stroke:#c0392b,color:white
    classDef external fill:#95a5a6,stroke:#7f8c8d,color:white

    subgraph Presentation
        UI[Activities & Fragments]:::ui
        Views[Views & Adapters]:::ui
        Search[Search UI]:::ui
        Feed[Feed UI]:::ui
        ReadingList[Reading List UI]:::ui
        EditUI[Edit Interface]:::ui
        PageView[Page View]:::ui
        NotifUI[Notifications UI]:::ui
    end

    subgraph BusinessLogic
        ViewModel[ViewModels]:::business
        SearchLogic[Search Logic]:::business
        FeedLogic[Feed Controller]:::business
        ReadingLogic[Reading List Logic]:::business
        EditLogic[Edit Controller]:::business
        PageLogic[Page Controller]:::business
        NotifLogic[Notification Controller]:::business
    end

    subgraph DataLayer
        LocalDB[(Local Database)]:::data
        Cache[Cache Management]:::data
        OfflineStorage[Offline Storage]:::data
        Repository[Data Repository]:::data
    end

    subgraph NetworkServices
        APIClient[API Client]:::network
        AuthService[Authentication]:::network
        ImageLoader[Image Loading]:::network
        Analytics[Analytics Service]:::network
    end

    subgraph ExternalSystems
        WikiAPI[Wikipedia API]:::external
        MediaWiki[MediaWiki Services]:::external
        Firebase[Firebase Services]:::external
        AnalyticsPlatform[Analytics Platform]:::external
    end

    %% Relationships
    UI --> ViewModel
    Views --> ViewModel
    Search --> SearchLogic
    Feed --> FeedLogic
    ReadingList --> ReadingLogic
    EditUI --> EditLogic
    PageView --> PageLogic
    NotifUI --> NotifLogic

    ViewModel --> Repository
    SearchLogic --> Repository
    FeedLogic --> Repository
    ReadingLogic --> Repository
    EditLogic --> Repository
    PageLogic --> Repository
    NotifLogic --> Repository

    Repository --> LocalDB
    Repository --> APIClient
    Repository --> Cache
    Repository --> OfflineStorage

    APIClient --> AuthService
    APIClient --> WikiAPI
    APIClient --> MediaWiki
    Analytics --> AnalyticsPlatform
    AuthService --> Firebase

    %% Click events
    click UI "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/activity/"
    click Views "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/views/"
    click LocalDB "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/database/"
    click APIClient "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/dataclient/"
    click AuthService "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/auth/"
    click Analytics "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/analytics/"
    click OfflineStorage "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/offline/"
    click Feed "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/feed/"
    click Search "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/search/"
    click ReadingList "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/readinglist/"
    click NotifUI "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/notifications/"
    click Firebase "https://github.com/wikimedia/apps-android-wikipedia/blob/main/app/google-services.json"
    click EditUI "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/edit/"
    click PageView "https://github.com/wikimedia/apps-android-wikipedia/tree/main/app/src/main/java/org/wikipedia/page/"
```
