# talmastera/fyp architecture

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

- Interactive diagram: https://gitdiagram.com/talmastera/fyp
- Repository: https://github.com/talmastera/fyp

## Overview

TalknLearn is an Android translation and language-learning app backed by Firebase Cloud Functions, Firestore, and Azure services. Users enter through the app’s navigation and can translate speech or scanned text, build learning materials from translation history, manage vocabulary, and use friend and sharing features. Account, settings, and history data sync through Firebase. The graph preserves README-documented capabilities, but sampled source only verifies some internal calls; unverified feature wiring is shown as dashed.

Main entry points: [`app/src/main/java/com/translator/TalknLearn/screens/speech/ContinuousConversationController.kt`](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/speech/ContinuousConversationController.kt) (Speech screens), [`app/src/main/java/com/translator/TalknLearn/screens/learning/LearningViewModel.kt`](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/learning/LearningViewModel.kt) (Learning screens), [`fyp-backend/functions/src/index.ts`](https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/index.ts) (Function exports), [`app/src/main/java/com/translator/TalknLearn/screens/friends/FriendsViewModel.kt`](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/friends/FriendsViewModel.kt) (Friends screens)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App shell"]
  node_navigation["App navigation<br/>[AppNavigation.kt]"]
  node_ui_language["UI language"]
end

subgraph group_language["Translation and speech"]
  node_speech_ui["Speech screens"]
  node_speech_usecases["Speech use cases"]
  node_speech_repo["Speech repository"]
  node_translation_client["Translation client"]
  node_ocr["Image OCR"]
end

subgraph group_learning["Learning and history"]
  node_history[("Translation history")]
  node_learning_ui["Learning screens"]
  node_learning_gen["Learning generation"]
  node_quiz_repo[("Quiz repository")]
  node_wordbank["Word bank"]
end

subgraph group_social["Accounts and friends"]
  node_auth["Authentication"]
  node_friends_ui["Friends screens"]
  node_friends_data[("Friends data")]
  node_chat_data[("Chat data")]
end

subgraph group_backend["Cloud services"]
  node_translation_fn["Translation functions<br/>[translation.ts]"]
  node_cloud_ai["AI functions<br/>[learning.ts]"]
  node_notifications["Push notifications<br/>[notifications.ts]"]
  node_function_entry["Function exports<br/>[index.ts]"]
end

node_user(("App user"))
node_azure_speech{{"Azure Speech"}}
node_azure_translate{{"Azure Translator"}}
node_firebase_auth{{"Firebase Auth"}}
node_firestore[("Cloud Firestore")]

node_user -->|"opens"| node_navigation
node_navigation -.->|"offers translation"| node_speech_ui
node_speech_ui -->|"starts conversation"| node_speech_usecases
node_speech_usecases -.->|"uses speech"| node_speech_repo
node_speech_repo -.->|"requests speech"| node_azure_speech
node_speech_ui -.->|"translates text"| node_translation_client
node_translation_client -.->|"calls function"| node_translation_fn
node_translation_fn -->|"requests translation"| node_azure_translate
node_user -.->|"scans image"| node_ocr
node_speech_ui -.->|"saves segments"| node_history
node_history -.->|"syncs records"| node_firestore
node_user -.->|"creates materials"| node_learning_ui
node_learning_ui -.->|"requests sheets"| node_learning_gen
node_learning_gen -.->|"generates content"| node_cloud_ai
node_learning_ui -.->|"manages quizzes"| node_quiz_repo
node_learning_ui -.->|"manages vocabulary"| node_wordbank
node_user -->|"signs in"| node_auth
node_auth -->|"authenticates"| node_firebase_auth
node_user -.->|"uses social features"| node_friends_ui
node_friends_ui -.->|"manages friends"| node_friends_data
node_friends_ui -.->|"sends messages"| node_chat_data
node_friends_data -.->|"reads and writes"| node_firestore
node_chat_data -.->|"reads and writes"| node_firestore
node_function_entry -->|"exports"| node_translation_fn
node_function_entry -->|"exports"| node_cloud_ai
node_function_entry -->|"exports"| node_notifications
node_chat_data -.->|"triggers push"| node_notifications
node_user -->|"changes interface language"| node_ui_language

click node_navigation "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/navigation/AppNavigation.kt"
click node_ui_language "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/ui/UiLanguageStateController.kt"
click node_speech_ui "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/speech/ContinuousConversationController.kt"
click node_speech_usecases "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/domain/speech/StartContinuousConversationUseCase.kt"
click node_speech_repo "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/repositories/AzureSpeechRepository.kt"
click node_translation_client "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/clients/CloudTranslatorClient.kt"
click node_translation_fn "https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/translation.ts"
click node_ocr "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/ocr/MLKitOcrRepository.kt"
click node_history "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/history/FirestoreHistoryRepository.kt"
click node_learning_ui "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/learning/LearningViewModel.kt"
click node_learning_gen "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/learning/LearningContentRepositoryImpl.kt"
click node_quiz_repo "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/learning/FirestoreQuizRepository.kt"
click node_wordbank "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/wordbank/WordBankGenerationRepository.kt"
click node_cloud_ai "https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/learning.ts"
click node_auth "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/user/FirebaseAuthRepository.kt"
click node_friends_ui "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/friends/FriendsViewModel.kt"
click node_friends_data "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/friends/FirestoreFriendsRepository.kt"
click node_chat_data "https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/friends/FirestoreChatRepository.kt"
click node_notifications "https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/notifications.ts"
click node_function_entry "https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/index.ts"

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_navigation,node_ui_language,node_user toneBlue
class node_speech_ui,node_speech_usecases,node_speech_repo,node_translation_client,node_ocr,node_firestore toneAmber
class node_history,node_learning_ui,node_learning_gen,node_quiz_repo,node_wordbank toneMint
class node_auth,node_friends_ui,node_friends_data,node_chat_data toneRose
class node_translation_fn,node_cloud_ai,node_notifications,node_function_entry,node_azure_speech,node_azure_translate,node_firebase_auth toneIndigo
```

## Components

### App shell

- [App navigation](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/navigation/AppNavigation.kt): `app/src/main/java/com/translator/TalknLearn/navigation/AppNavigation.kt`
- [UI language](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/ui/UiLanguageStateController.kt): `app/src/main/java/com/translator/TalknLearn/data/ui/UiLanguageStateController.kt`

### Translation and speech

- [Speech screens](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/speech/ContinuousConversationController.kt): `app/src/main/java/com/translator/TalknLearn/screens/speech/ContinuousConversationController.kt`
- [Speech use cases](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/domain/speech/StartContinuousConversationUseCase.kt): `app/src/main/java/com/translator/TalknLearn/domain/speech/StartContinuousConversationUseCase.kt`
- [Speech repository](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/repositories/AzureSpeechRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/repositories/AzureSpeechRepository.kt`
- [Translation client](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/clients/CloudTranslatorClient.kt): `app/src/main/java/com/translator/TalknLearn/data/clients/CloudTranslatorClient.kt`
- [Image OCR](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/ocr/MLKitOcrRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/ocr/MLKitOcrRepository.kt`

### Learning and history

- [Translation history](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/history/FirestoreHistoryRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/history/FirestoreHistoryRepository.kt`
- [Learning screens](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/learning/LearningViewModel.kt): `app/src/main/java/com/translator/TalknLearn/screens/learning/LearningViewModel.kt`
- [Learning generation](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/learning/LearningContentRepositoryImpl.kt): `app/src/main/java/com/translator/TalknLearn/data/learning/LearningContentRepositoryImpl.kt`
- [Quiz repository](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/learning/FirestoreQuizRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/learning/FirestoreQuizRepository.kt`
- [Word bank](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/wordbank/WordBankGenerationRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/wordbank/WordBankGenerationRepository.kt`

### Accounts and friends

- [Authentication](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/user/FirebaseAuthRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/user/FirebaseAuthRepository.kt`
- [Friends screens](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/screens/friends/FriendsViewModel.kt): `app/src/main/java/com/translator/TalknLearn/screens/friends/FriendsViewModel.kt`
- [Friends data](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/friends/FirestoreFriendsRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/friends/FirestoreFriendsRepository.kt`
- [Chat data](https://github.com/talmastera/fyp/blob/main/app/src/main/java/com/translator/TalknLearn/data/friends/FirestoreChatRepository.kt): `app/src/main/java/com/translator/TalknLearn/data/friends/FirestoreChatRepository.kt`

### Cloud services

- [Translation functions](https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/translation.ts): `fyp-backend/functions/src/translation.ts`
- [AI functions](https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/learning.ts): `fyp-backend/functions/src/learning.ts`
- [Push notifications](https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/notifications.ts): `fyp-backend/functions/src/notifications.ts`
- [Function exports](https://github.com/talmastera/fyp/blob/main/fyp-backend/functions/src/index.ts): `fyp-backend/functions/src/index.ts`

### Other components

- **App user**
- **Azure Speech**
- **Azure Translator**
- **Firebase Auth**
- **Cloud Firestore**

## Connections

- App user → App navigation: opens
- App navigation → Speech screens: offers translation
- Speech screens → Speech use cases: starts conversation (evidence: `app/src/main/java/com/translator/TalknLearn/screens/speech/ContinuousConversationController.kt`)
- Speech use cases → Speech repository: uses speech
- Speech repository → Azure Speech: requests speech
- Speech screens → Translation client: translates text
- Translation client → Translation functions: calls function
- Translation functions → Azure Translator: requests translation (evidence: `fyp-backend/functions/src/translation.ts`)
- App user → Image OCR: scans image
- Speech screens → Translation history: saves segments
- Translation history → Cloud Firestore: syncs records
- App user → Learning screens: creates materials
- Learning screens → Learning generation: requests sheets
- Learning generation → AI functions: generates content
- Learning screens → Quiz repository: manages quizzes
- Learning screens → Word bank: manages vocabulary
- App user → Authentication: signs in
- Authentication → Firebase Auth: authenticates (evidence: `app/src/main/java/com/translator/TalknLearn/data/user/FirebaseAuthRepository.kt`)
- App user → Friends screens: uses social features
- Friends screens → Friends data: manages friends
- Friends screens → Chat data: sends messages
- Friends data → Cloud Firestore: reads and writes
- Chat data → Cloud Firestore: reads and writes
- Function exports → Translation functions: exports (evidence: `fyp-backend/functions/src/index.ts`)
- Function exports → AI functions: exports (evidence: `fyp-backend/functions/src/index.ts`)
- Function exports → Push notifications: exports (evidence: `fyp-backend/functions/src/index.ts`)
- Chat data → Push notifications: triggers push
- App user → UI language: changes interface language (evidence: `app/src/main/java/com/translator/TalknLearn/data/ui/UiLanguageStateController.kt`)
