# sanketbodke/mern-recipe-app architecture

> Architecture diagram of the GitHub repository sanketbodke/mern-recipe-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sanketbodke/mern-recipe-app
- Repository: https://github.com/sanketbodke/mern-recipe-app

## Overview

##### Project Type and Purpose
- This is a full-stack, single-page web application (“Let’s Cook”) for managing user recipes.
- Frontend: React (Vite) SPA that handles user interactions, navigation, and UI.
- Backend: Node.js + Express API responsible for authentication, recipe CRUD, and user data.
- Database: A document store (e.g. MongoDB via Mongoose) to persist users and recipes.
- External Service: Cloudinary (or similar) for image storage and hosting.

##### File Structure Analysis
- Top-Level
- client/ → React application: src, components, pages, Redux store, Vite config, build output in dist/
- server/ → Express API: app.js, routes/, controllers/, models/, db/ (connection), utils/, constants.js
- Client Patterns
- Component hierarchy: shared UI (Navbar, Spinner), page components (home, auth, create/edit), routing (PrivateRoute)
- State management: Redux slice at src/redux/user
- Build scripts: Vite dev server and build pipeline
- Server Patterns
- MVC-style: routes → controllers → models
- Middleware utilities: asyncHandler, ApiError, ApiResponse
- DB layer: db/index.js establishes connection
- Environment/config: constants.js holds ports, DB URLs, JWT secrets

##### Key README Insights
- Features: recipe viewing, creation, editing, deletion, saving/bookmarking, user authentication
- Run setup: ‘npm run dev’ launches client at :5173 and server at :3001
- Build: client build artifacts in dist are likely served by the server in production

a. Main Components
- Browser/Client UI (React SPA)
- Vite Dev Server (development) or Static File Server (production)
- Express API Server
- Database Server (MongoDB)
- External Image Service (Cloudinary)
b. Relationships and Interactions
- Client ←→ API: RESTful endpoints for auth (login/register) and recipe operations (GET, POST, PUT, DELETE)
- Client → Cloudinary: direct upload widget for images, returns hosted URL
- API → Database: Mongoose models for User and Recipe
- API → Cloudinary (optional): image URL storage or cleanup on deletes
c. Architectural Patterns
- SPA front/back separation: clear boundary via HTTP/JSON API
- MVC on the server: routes → controllers → models
- State management via Redux in the client
- Error-handling middleware (asyncHandler, ApiError)
d. Technologies and Libraries
- React, React Router, Redux, Vite
- Node.js, Express, Mongoose (MongoDB)
- Cloudinary upload widget
- JWT or session tokens for auth
- ESLint, Prettier for code style

##### Diagramming Conventions
- Use clear component labels: “React App”, “Express API”, “MongoDB”, “Cloudinary”.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        ViteDev["Vite Dev Server"]:::frontend
        ReactApp["React Application"]:::frontend
        ReduxStore["Redux Store"]:::frontend
        Components["UI Components"]:::frontend
        Pages["Page Components"]:::frontend
        ConstantsFE["Frontend Constants"]:::frontend
        StaticBuild["Production Build (dist)"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Layer"
        direction TB
        ExpressAPI["Express API Server"]:::backend
        subgraph "API Structure"
            direction TB
            Routes["Routes"]:::backend
            Controllers["Controllers"]:::backend
            Models["Models"]:::backend
            Utils["Utils & Middleware"]:::backend
            DBConn["DB Connection"]:::backend
            ConfigBE["Backend Config"]:::backend
        end
    end

    %% External Services
    Cloudinary["Cloudinary"]:::external
    MongoDB["MongoDB"]:::db

    %% Frontend interactions
    ViteDev -->|serves| ReactApp
    ReactApp -->|uses| ReduxStore
    ReactApp -->|imports| Components
    ReactApp -->|imports| Pages
    ReactApp -->|reads| ConstantsFE
    ReactApp -->|in dev| ViteDev
    StaticBuild -->|served by| ExpressAPI

    %% Client-API interaction
    ReactApp -->|"HTTP REST API"| ExpressAPI

    %% Auth flow
    ReactApp -->|"POST /login, /register"| ExpressAPI
    ExpressAPI -->|"returns JWT"| ReactApp

    %% Recipe CRUD flow
    ReactApp -->|"GET/POST/PUT/DELETE /recipes"| ExpressAPI

    %% Image upload flow
    Components -->|widget| Cloudinary
    Cloudinary -->|URL| ReactApp
    ReactApp -->|"send image URL"| ExpressAPI
    ExpressAPI -->|store URL| MongoDB

    %% Backend internals
    ExpressAPI -->|uses| ConfigBE
    ExpressAPI -->|connects| DBConn
    DBConn -->|connects| MongoDB
    ExpressAPI -->|routes defined| Routes
    Routes -->|call| Controllers
    Controllers -->|use| Models
    Controllers -->|use| Utils
    Models -->|interact| MongoDB
    Utils -->|middleware| ExpressAPI

    %% Database and external
    ExpressAPI -->|cleanup| Cloudinary

    %% Click Events Frontend
    click ViteDev "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/vite.config.js"
    click ReactApp "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/App.jsx"
    click ReduxStore "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/redux/store.js"
    click Components "https://github.com/sanketbodke/mern-recipe-app/tree/main/client/src/components"
    click Pages "https://github.com/sanketbodke/mern-recipe-app/tree/main/client/src/pages"
    click ConstantsFE "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/constant.js"
    click StaticBuild "https://github.com/sanketbodke/mern-recipe-app/tree/main/client/dist/"

    %% Components clicks
    click Navbar "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/Navbar.jsx"
    click Spinner "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/Spinner.jsx"
    click PrivateRoute "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/PrivateRoute.jsx"
    click Error404 "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/Error404.jsx"
    click UploadWidget "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/UploadWidget.jsx"
    click RecipeDetailsModal "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/RecipeDetailsModal.jsx"
    click RecipeEditModal "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/components/RecipeEditModal.jsx"

    %% Pages clicks
    click HomePage "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/home.jsx"
    click CreateEditPage "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/createRecipe.jsx"
    click MyRecipesPage "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/myRecipes.jsx"
    click SavedRecipesPage "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/savedRecipes.jsx"
    click AuthLayout "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/auth/authLayout.jsx"
    click LoginForm "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/auth/forms/loginForm.jsx"
    click RegisterForm "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/pages/auth/forms/registerForm.jsx"

    %% Root and main
    click MainEntry "https://github.com/sanketbodke/mern-recipe-app/blob/main/client/src/main.jsx"

    %% Backend click events
    click ExpressAPI "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/app.js"
    click ConfigBE "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/constants.js"
    click DBConn "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/db/index.js"
    click Routes "https://github.com/sanketbodke/mern-recipe-app/tree/main/server/routes"
    click Controllers "https://github.com/sanketbodke/mern-recipe-app/tree/main/server/controllers"
    click Models "https://github.com/sanketbodke/mern-recipe-app/tree/main/server/models"
    click Utils "https://github.com/sanketbodke/mern-recipe-app/tree/main/server/utils"
    click ServerStart "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/index.js"
    click UserRoute "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/routes/user.route.js"
    click RecipeRoute "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/routes/recipe.route.js"
    click UserController "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/controllers/user.controller.js"
    click RecipeController "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/controllers/recipe.controller.js"
    click UserModel "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/models/user.model.js"
    click RecipeModel "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/models/recipe.model.js"
    click AsyncHandler "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/utils/asyncHandler.js"
    click ApiError "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/utils/ApiError.js"
    click ApiResponse "https://github.com/sanketbodke/mern-recipe-app/blob/main/server/utils/ApiResponse.js"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#2B7CE9,color:#000
    classDef backend fill:#D6F5D6,stroke:#28A745,color:#000
    classDef db fill:#FFDDAA,stroke:#FF8C00,color:#000
    classDef external fill:#FFEBCC,stroke:#FFA500,color:#000
```
