# coder-jon014/solidmeal_app architecture

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

- Interactive diagram: https://gitdiagram.com/coder-jon014/solidmeal_app
- Repository: https://github.com/coder-jon014/solidmeal_app

## Overview

##### Project type and purpose
- SolidMeal is a cross-platform mobile (Android, iOS, Web) Flutter application built with FlutterFlow.
- Purpose: help users with health conditions find personalized recipes using a client-side KNN algorithm plus external Spoonacular API data, storing user data in Firebase.

##### High-level file-structure observations
- Top-level “android”/“ios”/“web” folders host platform-specific boilerplate.
- “lib/” is the meat of the app:
- “lib/main.dart” and “lib/index.dart” launch the app
- “lib/flutter_flow/” contains UI scaffolding, theming, navigation, utilities
- “lib/components/”, “lib/custom_code/” and page folders (e.g., “startup_pages/”, “home/”, “recipe_pages/”) implement widgets + MVVM-style models (`*_widget.dart` + `*_model.dart`).
- “lib/auth/” handles authentication via Firebase Auth, JWT, Google, Apple, email, anonymous, etc.
- “lib/backend/” contains two subsections:
– “api_requests/” houses an ApiManager that calls the Spoonacular Recipe API
– “firebase/” + “firebase_storage/” + “schema/” define Firestore/Storage config and auto-generated record classes.
- “lib/custom_code/widgets/knn_recipe_comparison.dart” runs the KNN algorithm on recipe data.

##### Architectural patterns & tech stack (from README + code)
- Layered (presentation → view-model → service → data) resembling MVVM/Clean Architecture
- Flutter & FlutterFlow for UI
- State/models per page (generated by FlutterFlow)
- Service layer: AuthManager, ApiManager, FirebaseManager
- Data layer: Firestore collections + Firebase Storage
- External API: Spoonacular via RapidAPI (requires API_KEY in .env)
- Custom algorithm: KNN in Dart for recipe similarities
- NotificationService.swift for iOS push-notification image handling

- Flutter Widgets (screens & components)
- FlutterFlow navigation & theming
B. View-Model Layer (light blue)
- `*_model.dart` files hold state & trigger service calls
- AuthService (Firebase Auth via AuthManager)
- ApiService (Spoonacular API via ApiManager)
- FirebaseService (Firestore & Storage via Backend classes)
- KNN engine (custom_code widget)
- Firestore (users, recipes, notes, preferences collections)
- Firebase Storage (images, PDFs, other assets)
- Spoonacular Recipe & Nutrition API (RapidAPI)
- Android (Gradle, MainActivity.kt)
- iOS (AppDelegate.swift, NotificationService.swift)

1. User interacts with Flutter UI → calls ViewModel
2. ViewModel invokes Service Layer (AuthService / ApiService / FirebaseService)
3. Service Layer:
- AuthService ↔ Firebase Auth
- ApiService ↔ Spoonacular API
- FirebaseService ↔ Firestore & Storage
- KNN engine reads recipe data & user profile → returns recommendations
4. Data returns up the chain → ViewModel updates UI

##### Key architectural patterns & design principles
- Separation of concerns: UI vs. state vs. services vs. data
- Repository-style services encapsulate external dependencies
- Generated models ensure type safety for Firestore schema
- Dependency inversion: widgets depend on abstract managers, not direct API calls
- Single source of truth in ViewModels

## Diagram (Mermaid)

```mermaid
flowchart TB
  %% Presentation Layer
  subgraph "Presentation Layer" 
    UIWidgets["Screens & Components"]:::ui
    Main["main.dart"]:::ui
    Index["index.dart"]:::ui
    Theme["flutter_flow_theme.dart"]:::ui
    Nav["nav.dart"]:::ui
    FFWidgets["flutter_flow_widgets.dart"]:::ui
  end

  %% ViewModel Layer
  subgraph "View-Model Layer"
    HomeVM["home_model.dart"]:::viewModel
  end

  %% Service Layer
  subgraph "Service Layer"
    AuthSvc["AuthManager\n(auth_manager.dart)"]:::service
    AuthImpl["Firebase Auth Implementations"]:::service
    ApiSvc["ApiManager\n(api_manager.dart)"]:::service
    APICalls["api_calls.dart"]:::service
    FirebaseConfig["firebase_config.dart"]:::service
    StorageSvc["storage.dart"]:::service
    BackendSvc["backend.dart"]:::service
    KNN["knn_recipe_comparison.dart"]:::service
  end

  %% Data Layer
  subgraph "Data Layer"
    Firestore["Firestore Collections"]:::data
    UsersRec["users_record.dart"]:::data
    RecipesRec["recipes_record.dart"]:::data
    NotesRec["notes_for_recipes_record.dart"]:::data
    StorageDS["Firebase Storage"]:::data
  end

  %% External Services
  subgraph "External Services"
    Spoonacular["Spoonacular API\n(RapidAPI)"]:::external
    Env[".env.example"]:::external
  end

  %% Platform Adaptation
  subgraph "Platform Adaptation"
    Android["MainActivity.kt"]:::platform
    iOSApp["AppDelegate.swift"]:::platform
    NotificationSvc["NotificationService.swift"]:::platform
  end

  %% Connections
  UIWidgets -->|"interacts with"| HomeVM
  Main --> UIWidgets
  Index --> UIWidgets
  Theme --> UIWidgets
  Nav --> UIWidgets
  FFWidgets --> UIWidgets

  HomeVM -->|"calls"| AuthSvc
  HomeVM -->|"calls"| ApiSvc
  HomeVM -->|"calls"| BackendSvc
  HomeVM -->|"uses"| KNN

  AuthSvc -->|"uses"| AuthImpl
  ApiSvc -->|"calls"| APICalls
  ApiSvc -->|"connects to"| Spoonacular
  BackendSvc -->|"configures"| FirebaseConfig
  BackendSvc -->|"writes/reads"| StorageSvc
  BackendSvc -->|"writes/reads"| BackendSvc
  BackendSvc -->|"reads/writes"| Firestore
  KNN -->|"reads"| Firestore

  Firestore --> UsersRec
  Firestore --> RecipesRec
  Firestore --> NotesRec
  StorageDS --> BackendSvc

  Spoonacular --> Env

  Android --> UIWidgets
  iOSApp --> UIWidgets
  NotificationSvc --> UIWidgets

  %% Click Events
  click Android "https://github.com/coder-jon014/solidmeal_app/blob/master/android/app/src/main/kotlin/com/example/my_project/MainActivity.kt"
  click iOSApp "https://github.com/coder-jon014/solidmeal_app/blob/master/ios/Runner/AppDelegate.swift"
  click NotificationSvc "https://github.com/coder-jon014/solidmeal_app/blob/master/ios/ImageNotification/NotificationService.swift"
  click Main "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/main.dart"
  click Index "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/index.dart"
  click Theme "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/flutter_flow/flutter_flow_theme.dart"
  click Nav "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/flutter_flow/nav/nav.dart"
  click FFWidgets "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/flutter_flow/flutter_flow_widgets.dart"
  click UIWidgets "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/home/home/home_widget.dart"
  click HomeVM "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/home/home/home_model.dart"
  click AuthSvc "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/auth/auth_manager.dart"
  click AuthImpl "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/auth/firebase_auth/firebase_auth_manager.dart"
  click APICalls "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/api_requests/api_calls.dart"
  click ApiSvc "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/api_requests/api_manager.dart"
  click FirebaseConfig "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/firebase/firebase_config.dart"
  click StorageSvc "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/firebase_storage/storage.dart"
  click BackendSvc "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/backend.dart"
  click UsersRec "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/schema/users_record.dart"
  click RecipesRec "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/schema/recipes_record.dart"
  click NotesRec "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/backend/schema/notes_for_recipes_record.dart"
  click KNN "https://github.com/coder-jon014/solidmeal_app/blob/master/lib/custom_code/widgets/knn_recipe_comparison.dart"
  click Env "https://github.com/coder-jon014/solidmeal_app/blob/master/.env.example"

  %% Styles
  classDef ui fill:#D0E7FF,stroke:#333,stroke-width:1px
  classDef viewModel fill:#E0F7FF,stroke:#333,stroke-width:1px
  classDef service fill:#D0FFD0,stroke:#333,stroke-width:1px
  classDef data fill:#FFE0B2,stroke:#333,stroke-width:1px
  classDef external fill:#E5D3FF,stroke:#333,stroke-width:1px
  classDef platform fill:#E0E0E0,stroke:#333,stroke-width:1px
```
