# qwe8851/yumseoul architecture

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

- Interactive diagram: https://gitdiagram.com/qwe8851/yumseoul
- Repository: https://github.com/qwe8851/yumseoul

## Overview

##### Project type and purpose
- This is a full-stack delivery application called “YumSeoul.”
- Frontend: React + Redux Toolkit + styled-components single-page app.
- Backend: Node.js/Express REST API with MongoDB (via Mongoose).
- Purpose: Users browse stores, view details, upload images, manage carts, and place orders. It includes authentication (JWT + bcrypt), password reset (crypto + nodemailer), and file uploads (Multer-S3 to AWS S3).

##### File structure
- Top level (backend):
- config/ – environment and DB configuration (development.js, production.js, mongo-db.js, key.js)
- models/ – Mongoose models (main, store, todo, upload, user)
- routes/ – Express routes for each resource (mains, stores, todos, uploads, users)
- public/ – static folder where the React build is served (index.html, manifest.json, robots.txt)
- server.js – application entry point, sets up Express, middleware, routes, and static serving.
- Frontend (yum-seoul-project):
- public/ – SPA host page (index.html)
- src/ – React app:
– components/ – reusable UI pieces (common, layout)
– pages/ – route components (Auth, Home, Main, Error)
– store/ – Redux slices (authSlice, storesSlice) and store setup
– utils/ – helpers (firebaseAuth)
– hooks/ – custom hooks (use-input)
– assets/, styles/ – CSS, fonts, styled-components
– App.js, index.js, routing, tests, build scripts

##### README for additional insights
- Technology stack and libraries (React, Redux Toolkit, styled-components, Node.js, MongoDB, Mongoose, bcrypt, JWT, Multer-S3, AWS S3, Nodemailer).
- Build instructions show that the React build is output into a folder served by the Node server.
- Implementation details: password hashing, AWS S3 uploads, email via SMTP.

##### Elements
- Clear labels (e.g., “React SPA,” “Express API,” “MongoDB,” “AWS S3,” “SMTP Server”)
- UI → API (data requests)
- API → DB (data reads/writes)
- API → S3 (upload)
- API → Email Service (send email)
- Blue for client components
- Green for server components
- Orange for database
- Gray for external services

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Layers
    subgraph "Presentation Layer" 
        direction TB
        Browser["User Browser"]:::client
        subgraph "React SPA" 
            direction TB
            Index["index.js"]:::client
            App["App.js (Routing)"]:::client
            StoreCfg["store/store.js"]:::client
            AuthSlice["authSlice.js"]:::client
            StoresSlice["storesSlice.js"]:::client
            ComponentsCommon["components/common/"]:::client
            ComponentsLayout["components/layout/"]:::client
            Pages["pages/"]:::client
            Hook["use-input.js"]:::client
            Utils["firebaseAuth.js"]:::client
            Styles["Layout.styled.js & assets/styles/"]:::client
            StaticHost["public/index.html"]:::client
        end
    end

    subgraph "Business/Data Layer"
        direction TB
        API["Express API Server\n(server.js)"]:::server
        subgraph "Config" 
            direction TB
            DevConfig["development.js"]:::server
            ProdConfig["production.js"]:::server
            KeyConfig["key.js"]:::server
            MongoConfig["mongo-db.js"]:::server
        end
        subgraph "Routes (Controllers)" 
            direction TB
            RoutesMains["mains.js"]:::server
            RoutesStores["stores.js"]:::server
            RoutesTodos["todos.js"]:::server
            RoutesUploads["uploads.js"]:::server
            RoutesUsers["users.js"]:::server
        end
        subgraph "Models" 
            direction TB
            ModelMain["main.js"]:::server
            ModelStore["store.js"]:::server
            ModelTodo["todo.js"]:::server
            ModelUpload["upload.js"]:::server
            ModelUser["user.js"]:::server
        end
        DB["MongoDB"]:::database
        S3["AWS S3 Bucket"]:::external
        SMTP["SMTP Email Service"]:::external
    end

    %% Connections
    Browser -->|"loads SPA"| Index
    Index -->|renders| App
    App -->|"dispatch actions"| StoreCfg
    StoreCfg -->|"uses slices"| AuthSlice
    StoreCfg -->|"uses slices"| StoresSlice
    App -->|uses| ComponentsCommon
    App -->|uses| ComponentsLayout
    App -->|routes to| Pages
    Pages -->|uses| Hook
    Pages -->|uses| Utils
    Pages -->|styled by| Styles
    Browser -->|static serve| StaticHost

    StaticHost -->|served by| API
    API -->|loads config| DevConfig
    API -->|loads config| ProdConfig
    API -->|loads config| KeyConfig
    API -->|loads config| MongoConfig
    API -->|"exposes REST endpoints"| RoutesMains
    API -->|"exposes REST endpoints"| RoutesStores
    API -->|"exposes REST endpoints"| RoutesTodos
    API -->|"exposes REST endpoints"| RoutesUploads
    API -->|"exposes REST endpoints"| RoutesUsers

    RoutesMains -->|CRUD| ModelMain
    RoutesStores -->|CRUD| ModelStore
    RoutesTodos -->|CRUD| ModelTodo
    RoutesUploads -->|CRUD| ModelUpload
    RoutesUsers -->|CRUD & auth| ModelUser

    RoutesUploads -->|upload images| S3
    RoutesUsers -->|send reset email| SMTP
    RoutesUsers -->|hash & token| ModelUser

    API -->|connect| DB

    %% Click Events
    click Index "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/index.js"
    click App "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/App.js"
    click StoreCfg "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/store/store.js"
    click AuthSlice "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/store/authSlice.js"
    click StoresSlice "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/store/storesSlice.js"
    click ComponentsCommon "https://github.com/qwe8851/yumseoul/tree/main/yum-seoul-project/src/components/common/"
    click ComponentsLayout "https://github.com/qwe8851/yumseoul/tree/main/yum-seoul-project/src/components/layout/"
    click Pages "https://github.com/qwe8851/yumseoul/tree/main/yum-seoul-project/src/pages/"
    click Hook "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/hooks/use-input.js"
    click Utils "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/utils/firebaseAuth.js"
    click Styles "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/src/styles/Layout.styled.js"
    click StaticHost "https://github.com/qwe8851/yumseoul/blob/main/yum-seoul-project/public/index.html"
    click API "https://github.com/qwe8851/yumseoul/blob/main/server.js"
    click DevConfig "https://github.com/qwe8851/yumseoul/blob/main/config/development.js"
    click ProdConfig "https://github.com/qwe8851/yumseoul/blob/main/config/production.js"
    click KeyConfig "https://github.com/qwe8851/yumseoul/blob/main/config/key.js"
    click MongoConfig "https://github.com/qwe8851/yumseoul/blob/main/config/mongo-db.js"
    click ModelMain "https://github.com/qwe8851/yumseoul/blob/main/models/main.js"
    click ModelStore "https://github.com/qwe8851/yumseoul/blob/main/models/store.js"
    click ModelTodo "https://github.com/qwe8851/yumseoul/blob/main/models/todo.js"
    click ModelUpload "https://github.com/qwe8851/yumseoul/blob/main/models/upload.js"
    click ModelUser "https://github.com/qwe8851/yumseoul/blob/main/models/user.js"
    click RoutesMains "https://github.com/qwe8851/yumseoul/blob/main/routes/mains.js"
    click RoutesStores "https://github.com/qwe8851/yumseoul/blob/main/routes/stores.js"
    click RoutesTodos "https://github.com/qwe8851/yumseoul/blob/main/routes/todos.js"
    click RoutesUploads "https://github.com/qwe8851/yumseoul/blob/main/routes/uploads.js"
    click RoutesUsers "https://github.com/qwe8851/yumseoul/blob/main/routes/users.js"

    %% Styles
    classDef client fill:#EEF5FF,stroke:#2F6FC0,color:#2F6FC0
    classDef server fill:#EDF9EE,stroke:#2F8C2E,color:#2F8C2E
    classDef database fill:#FFF4E5,stroke:#E09A18,color:#E09A18
    classDef external fill:#F2F2F2,stroke:#7A7A7A,color:#7A7A7A
```
