# mrtaz77/brain-train architecture

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

- Interactive diagram: https://gitdiagram.com/mrtaz77/brain-train
- Repository: https://github.com/mrtaz77/brain-train

## Overview

##### Project Type and Purpose
- Geeky Chef is a full‐stack web application providing AI‐driven meal planning, recipe discovery, nutrition analysis, and food image recognition.
- The backend is a modular Node + Express API; the frontend is a Vite‐built React application.

##### File Structure
- Top‐level:
- backend/ – Express app, subdivided into domain “apps” (ai-assistance, mealplan, search, favourite, trending, user, signin, signup), each with routes, controllers, DB connectors, middleware, tests, and utils.
- backend/libraries/ – shared Mongoose models and external service wrappers (Spoonacular, Firebase, Gemini, Clarifai), using factory patterns.
- backend/config/ – server config, CORS, middleware, Swagger, Jest setup.
- frontend/ – React src/ folder organized by components (per feature), pages, services (API call abstractions), config, assets, theme.
- CI/CD & infra configs: .github/workflows, vercel.json, sonar‐project.properties.
- erd/ERD.md – entity relationship definitions for MongoDB collections.

##### README for Insights
- Modules described:
- Recipe Discovery (search/filter history)
- Meal Planning (weekly plans + shopping lists)
- Nutritional Analysis (AI nutrition breakdown)
- Food Recognition (image upload → Clarifai/Gemini)
- User Management (Firebase Auth, profiles)
- Analytics & Insights (dashboards)
- Tech stack: Node, Express, MongoDB/Mongoose, Firebase, Spoonacular, Gemini, Clarifai; React, Chakra UI, Framer Motion; Jest tests; GitHub Actions; Vercel deploy; SonarCloud & Snyk security.

##### Main Components & Their Interactions
a. Frontend (React App)
– UI pages & feature‐specific components call REST endpoints via API abstraction (frontend/src/services/APIcall.js).
b. API Gateway (Express server)
– Single Node process (server.js) loads multiple domain routers (backend/apps/**/routes.js), applies global middleware (backend/config/middleware.js) and CORS (backend/config/cors.js).
c. Domain Modules
– Each “apps” folder encapsulates its own routes → controllers → DB layer (via Mongoose models in libraries/models/*.js) → utilities and middleware for validation, file uploads, etc.
d. Database
– MongoDB accessed through Mongoose. Collections modeled under backend/libraries/models.
e. External Services
– Firebase (Auth + image storage)
– Spoonacular API (recipe & nutrition data)
– Gemini & Clarifai (vision and chat AI services via service‐factory patterns)
f. Testing & CI
– Jest tests alongside each app.
– GitHub Actions → runs CI, SonarCloud analysis, deploys frontend to Vercel, backend serverless (vercel.json).

##### Architectural Patterns & Design Principles
- Modular monolith backend: domain‐centric apps with clear API boundaries.
- MVC‐style within each module: routes → controllers → services → data models.
- Factory pattern for pluggable AI services (chatFactory, visionFactory).
- Shared libraries to avoid duplication (models, common services).
- Component‐based frontend with separation of concerns (UI, data‐fetching, state).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    UI["Geeky Chef UI (React/ChakraUI)"]:::internal
    click UI "https://github.com/mrtaz77/brain-train/tree/main/frontend/src"

    %% API Gateway
    API["Express API Gateway"]:::internal
    click API "https://github.com/mrtaz77/brain-train/blob/main/backend/server.js"
    API --> appInit
    API --> appTest
    API --> mw
    API --> cors
    API --> swagger

    appInit["App Initialization"]:::internal
    click appInit "https://github.com/mrtaz77/brain-train/blob/main/backend/app.js"
    appTest["App Tests"]:::internal
    click appTest "https://github.com/mrtaz77/brain-train/blob/main/backend/app.test.js"
    mw["Global Middleware"]:::internal
    click mw "https://github.com/mrtaz77/brain-train/blob/main/backend/config/middleware.js"
    cors["CORS Configuration"]:::internal
    click cors "https://github.com/mrtaz77/brain-train/blob/main/backend/config/cors.js"
    swagger["Swagger Documentation"]:::internal
    click swagger "https://github.com/mrtaz77/brain-train/blob/main/backend/config/swagger.js"

    %% API Modules
    subgraph "API Modules"
        aiRouter["AI Assistance"]:::internal
        click aiRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/ai-assistance/api/routes.js"
        mealRouter["Meal Planning"]:::internal
        click mealRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/mealplan/api/routes.js"
        searchRouter["Recipe Discovery"]:::internal
        click searchRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/search/api/routes.js"
        favRouter["Favourites"]:::internal
        click favRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/favourite/api/routes.js"
        trendRouter["Trending Recipes"]:::internal
        click trendRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/trending/api/routes.js"
        userRouter["User Management"]:::internal
        click userRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/user/api/routes.js"
        signinRouter["Sign In"]:::internal
        click signinRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/signin/api/routes.js"
        signupRouter["Sign Up"]:::internal
        click signupRouter "https://github.com/mrtaz77/brain-train/blob/main/backend/apps/signup/api/routes.js"
    end

    %% Shared Libraries
    subgraph "Shared Libraries"
        models["Mongoose Models"]:::data
        click models "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/models/*.js"
        services["External Service Wrappers"]:::external
        click services "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/firebase.js"
        click services "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/spoonacular.js"
        click services "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/chat-service/chatFactory.js"
        click services "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/vision-service/visionFactory.js"
        util["Error Handler"]:::internal
        click util "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/util/errorHandler.js"
    end

    %% Database
    DB["MongoDB (Mongoose)"]:::dataStore

    %% External Services
    Firebase["Firebase Auth/Storage"]:::external
    click Firebase "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/firebase.js"
    Spoon["Spoonacular API"]:::external
    click Spoon "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/spoonacular.js"
    Gemini["Gemini AI (Chat)"]:::external
    click Gemini "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/chat-service/geminiService.js"
    Clarifai["Clarifai AI (Vision)"]:::external
    click Clarifai "https://github.com/mrtaz77/brain-train/blob/main/backend/libraries/services/vision-service/clarifaiService.js"

    %% CI/CD Pipeline
    GitHub["GitHub Actions"]:::pipeline
    click GitHub "https://github.com/mrtaz77/brain-train/blob/main/.github/workflows/ci.yml"
    GitHub --> VercelFE
    GitHub --> VercelBE
    VercelFE["Vercel Frontend"]:::pipeline
    click VercelFE "https://github.com/mrtaz77/brain-train/blob/main/frontend/vercel.json"
    VercelBE["Vercel Backend"]:::pipeline
    click VercelBE "https://github.com/mrtaz77/brain-train/blob/main/backend/vercel.json"

    %% Data Flows
    UI -->|"HTTP/REST"| API
    API -->|"routes to modules"| aiRouter
    API --> mealRouter
    API --> searchRouter
    API --> favRouter
    API --> trendRouter
    API --> userRouter
    API --> signinRouter
    API --> signupRouter

    aiRouter --> models
    mealRouter --> models
    searchRouter --> models
    favRouter --> models
    trendRouter --> models
    userRouter --> models
    signinRouter --> models
    signupRouter --> models

    aiRouter --> services
    mealRouter --> services
    searchRouter --> services
    favRouter --> services
    trendRouter --> services
    userRouter --> services
    signinRouter --> services
    signupRouter --> services

    models --> DB
    services --> Firebase
    services --> Spoon
    services --> Gemini
    services --> Clarifai

    %% Testing Hooks
    API -.->|"uses jest setup"| jestSetup
    API -.->|"uses jest teardown"| jestTeardown
    jestSetup["Jest Global Setup"]:::internal
    click jestSetup "https://github.com/mrtaz77/brain-train/blob/main/backend/config/jest/jest.globalSetup.js"
    jestTeardown["Jest Global Teardown"]:::internal
    click jestTeardown "https://github.com/mrtaz77/brain-train/blob/main/backend/config/jest/jest.setup.js"

    classDef internal fill:#D6EAF8,stroke:#21618C,stroke-width:1px
    classDef external fill:#EBF5FB,stroke:#5DADE2,stroke-width:1px
    classDef data fill:#FCF3CF,stroke:#B7950B,stroke-width:1px
    classDef dataStore fill:#FADBD8,stroke:#C0392B,stroke-width:1px
    classDef pipeline fill:#D5F5E3,stroke:#27AE60,stroke-width:1px
```
