# marcoxmarquez/verificamtc architecture

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

- Interactive diagram: https://gitdiagram.com/marcoxmarquez/verificamtc
- Repository: https://github.com/marcoxmarquez/verificamtc

## Overview

##### Project type and purpose
- Project type: Native Android full-client application for identity verification in driving exams.
- Purpose: Capture user/admin interactions, perform facial recognition locally using TensorFlow Lite & ML Kit, store user data locally (SQLite) and in the cloud (Firebase Realtime Database), manage authentication (Firebase Auth), and present dashboards and workflows for admin and test candidates.

##### File structure
- Top-level “app” module containing:
- build.gradle.kts, proguard rules, google-services.json
- src/main/java/com/master/verificamtc/… ‑ organized into packages:
– auth (login & registration Activities)
– admin/dashboard (AdminDashboardActivity)
– user/(circuit|dashboard|exam|payment|vehicle) (Activities per user workflow)
– helpers:
· database (AppDatabase.java for local SQLite, FirebaseDatabaseHelper.java for cloud sync)
· vision/recogniser (FaceRecognitionProcessor.java, FaceGraphic.java)
· vision (GraphicOverlay.java, VisionBaseProcessor.java)
· object (FaceRecognitionActivity.java)
· MLVideoHelperActivity.java
· SecurityHelper.java (BCrypt, input validation)
– assets & ml directory: several .tflite models & vocab/label files
- src/main/res: layouts, drawables, XML configs (backup, fileprovider)
- test & androidTest folders for unit & instrumented tests
- No separate server code – uses Firebase BaaS for backend.

##### README insights
- Architecture is client-heavy: authentication + data via Firebase, local cache via SQLite, ML inference on device.
- ML models: mobile_face_net.tflite in res/ml, plus other TFLite assets.
- Firebase services: Auth, Realtime Database.
- Android frameworks: CameraX, ML Kit, Material Design.

##### Main components
a. Android Client (app module)
- UI Layer: Activities (Auth, AdminDashboard, User workflows)
- Presentation: XML layouts, Material Components
- CameraX & ML Kit: capture frames, pass to VisionBaseProcessor
- ML Inference Engine: TensorFlow Lite models (.tflite assets) handled by FaceRecognitionProcessor
- Local Storage: Room/SQLite (AppDatabase)
- Security Layer: SecurityHelper (BCrypt hashing, input validation)
b. Cloud Services (Firebase)
- Firebase Auth (user/admin login & session)
- Firebase Realtime Database (user records, exam results, vehicle data)
c. External Assets
- TFLite models in assets & res/ml
d. Testing
- Unit tests & Instrumented tests folders

##### Relationships & interactions
- UI Layer → SecurityHelper for input validation & password hashing
- UI Layer → AppDatabase for local query & cache
- UI Layer → FirebaseDatabaseHelper to read/write remote cloud data
- CameraX → VisionBaseProcessor → FaceRecognitionProcessor → TFLite model → results returned to UI
- Auth Activities ↔ Firebase Auth service
- AdminDashboardActivity & UserDashboardActivity ↔ FirebaseDatabaseHelper
- MLVideoHelperActivity orchestrates video capture & ML pipeline

##### Architectural patterns & design principles
- MVVM/MVP-like separation: UI Activities delegate processing to helper classes
- Repository pattern for data: FirebaseDatabaseHelper & AppDatabase unify data sources
- Single Responsibility: each helper class focuses on one domain (vision, database, security)
- On-device inference to minimize latency and preserve privacy

##### Be detailed and capture all essential elements
- Major Activity as its own node or group them by “Auth,” “Admin,” “User workflows”
- Asset directories for ML models to show where inference artifacts reside

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        AuthSelectorActivity["AuthSelectorActivity"]:::ui
        AuthAdminActivity["AuthAdminActivity"]:::ui
        AuthUserActivity["AuthUserActivity"]:::ui
        AuthRegisterActivity["AuthRegisterActivity"]:::ui
        AdminDashboardActivity["AdminDashboardActivity"]:::ui
        UserCircuitActivity["UserCircuitActivity"]:::ui
        UserDashboardActivity["UserDashboardActivity"]:::ui
        UserExamActivity["UserExamActivity"]:::ui
        UserPaymentActivity["UserPaymentActivity"]:::ui
        UserVehicleActivity["UserVehicleActivity"]:::ui
        MLVideoHelperActivity["MLVideoHelperActivity"]:::ui
        FaceRecognitionActivity["FaceRecognitionActivity"]:::ui
    end

    %% Domain / Business Layer
    subgraph "Domain Layer (Helpers)"
        direction TB
        SecurityHelper["SecurityHelper"]:::security
        AppDatabase["AppDatabase"]:::data
        FirebaseDatabaseHelper["FirebaseDatabaseHelper"]:::data
        VisionBaseProcessor["VisionBaseProcessor"]:::vision
        GraphicOverlay["GraphicOverlay"]:::vision
        FaceGraphic["FaceGraphic"]:::vision
        FaceRecognitionProcessor["FaceRecognitionProcessor"]:::vision
    end

    %% ML Layer
    subgraph "ML Layer"
        direction TB
        TFLiteModels["TensorFlow Lite Models"]:::ml
        LabelAssets["Label/Vocab Files"]:::ml
        MobileFaceNet["mobile_face_net.tflite"]:::ml
    end

    %% Data Layer
    subgraph "Local Storage"
        direction TB
        SQLite["SQLite (Room)"]:::storage
    end

    %% Cloud Services
    subgraph "Firebase BaaS"
        direction TB
        FirebaseAuth["Firebase Auth"]:::cloud
        RealtimeDB["Firebase Realtime Database"]:::cloud
    end

    %% Interactions
    AuthSelectorActivity -->|validates| SecurityHelper
    AuthAdminActivity -->|hash/login| SecurityHelper
    AuthUserActivity -->|hash/login| SecurityHelper
    AuthRegisterActivity -->|hash/register| SecurityHelper
    AuthSelectorActivity -->|auth calls| FirebaseAuth
    AuthAdminActivity -->|auth calls| FirebaseAuth
    AuthUserActivity -->|auth calls| FirebaseAuth
    AuthRegisterActivity -->|auth calls| FirebaseAuth

    AdminDashboardActivity -->|read/write| FirebaseDatabaseHelper
    UserDashboardActivity -->|read/write| FirebaseDatabaseHelper
    UserCircuitActivity -->|read/write| FirebaseDatabaseHelper
    UserExamActivity -->|read/write| FirebaseDatabaseHelper
    UserPaymentActivity -->|read/write| FirebaseDatabaseHelper
    UserVehicleActivity -->|read/write| FirebaseDatabaseHelper

    AdminDashboardActivity -->|cache| AppDatabase
    UserDashboardActivity -->|cache| AppDatabase
    UserCircuitActivity -->|cache| AppDatabase
    UserExamActivity -->|cache| AppDatabase
    UserPaymentActivity -->|cache| AppDatabase
    UserVehicleActivity -->|cache| AppDatabase

    MLVideoHelperActivity -->|captures frames| VisionBaseProcessor
    VisionBaseProcessor -->|overlay| GraphicOverlay
    VisionBaseProcessor -->|draw| FaceGraphic
    VisionBaseProcessor -->|process| FaceRecognitionProcessor
    FaceRecognitionProcessor -->|infer| TFLiteModels
    FaceRecognitionProcessor -->|infer| MobileFaceNet
    TFLiteModels -->|use| LabelAssets
    FaceRecognitionActivity -->|orchestrates| FaceRecognitionProcessor

    FirebaseAuth -->|manages| RealtimeDB
    FirebaseDatabaseHelper -->|sync| RealtimeDB

    %% Click Events
    click AuthSelectorActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/auth/AuthSelectorActivity.java"
    click AuthAdminActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/auth/AuthAdminActivity.java"
    click AuthUserActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/auth/AuthUserActivity.java"
    click AuthRegisterActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/auth/AuthRegisterActivity.java"
    click AdminDashboardActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/admin/dashboard/AdminDashboardActivity.java"
    click UserCircuitActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/user/circuit/UserCircuitActivity.java"
    click UserDashboardActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/user/dashboard/UserDashboardActivity.java"
    click UserExamActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/user/exam/UserExamActivity.java"
    click UserPaymentActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/user/payment/UserPaymentActivity.java"
    click UserVehicleActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/user/vehicle/UserVehicleActivity.java"
    click MLVideoHelperActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/MLVideoHelperActivity.java"
    click VisionBaseProcessor "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/VisionBaseProcessor.java"
    click GraphicOverlay "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/vision/GraphicOverlay.java"
    click FaceGraphic "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/vision/FaceGraphic.java"
    click FaceRecognitionProcessor "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/vision/recogniser/FaceRecognitionProcessor.java"
    click FaceRecognitionActivity "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/object/FaceRecognitionActivity.java"
    click AppDatabase "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/AppDatabase.java"
    click FirebaseDatabaseHelper "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/helpers/FirebaseDatabaseHelper.java"
    click SecurityHelper "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/java/com/master/verificamtc/utils/SecurityHelper.java"
    click TFLiteModels "https://github.com/marcoxmarquez/verificamtc/tree/main/app/src/main/assets/"
    click LabelAssets "https://github.com/marcoxmarquez/verificamtc/tree/main/app/src/main/assets/"
    click MobileFaceNet "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/main/ml/mobile_face_net.tflite"
    click FirebaseAuth "https://github.com/marcoxmarquez/verificamtc/blob/main/app/google-services.json"
    click RealtimeDB "https://github.com/marcoxmarquez/verificamtc/blob/main/app/google-services.json"
    click SQLite "https://github.com/marcoxmarquez/verificamtc/tree/main/app/"
    click AppDatabase "https://github.com/marcoxmarquez/verificamtc/blob/main/app/build.gradle.kts"
    click AppDatabase "https://github.com/marcoxmarquez/verificamtc/blob/main/app/proguard-rules.pro"
    click AuthorModule "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/test/java/com/master/verificamtc/ExampleUnitTest.java"
    click AuthorModule "https://github.com/marcoxmarquez/verificamtc/blob/main/app/src/androidTest/java/com/master/verificamtc/ExampleInstrumentedTest.java"

    %% Styles
    classDef ui fill:#cce5ff,stroke:#004085,color:#004085
    classDef security fill:#e2e3e5,stroke:#6c757d,color:#383d41
    classDef data fill:#d4edda,stroke:#155724,color:#155724
    classDef storage fill:#d1ecf1,stroke:#0c5460,color:#0c5460
    classDef vision fill:#fff3cd,stroke:#856404,color:#856404
    classDef ml fill:#ffe5b4,stroke:#ff8c00,color:#ff8c00
    classDef cloud fill:#f8d7da,stroke:#721c24,color:#721c24
```
