# team-omechu/omechu-server architecture

> Architecture diagram of the GitHub repository team-omechu/omechu-server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/team-omechu/omechu-server
- Repository: https://github.com/team-omechu/omechu-server

## Overview

Omechu is a context-aware menu and restaurant recommendation backend organized as an API gateway and three Node.js services. A client request enters the gateway, reaches an API service, and is handled through controller, service, and repository layers; the README describes MySQL-backed services and additional Redis, S3, and embedding capabilities. The tree also shows menu battles, restaurant search, user profiles, recommendation exclusions, and meal alerts. Some connections below are documented only at the system level because service entry points and several implementations were not sampled.

Main entry points: [`backend/menu/src/index.js`](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/index.js) (Menu API), [`backend/auth/src/index.js`](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/index.js) (Auth API), [`backend/user/src/index.js`](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/index.js) (User API), [`backend/default_container/index.js`](https://github.com/team-omechu/omechu-server/blob/develop/backend/default_container/index.js) (Request router)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_gateway["API gateway"]
  node_gateway_app["Request router<br/>[index.js]"]
end

subgraph group_auth["Authentication"]
  node_auth_api["Auth API<br/>[index.js]"]
  node_auth_flows["Login and OAuth"]
  node_auth_email["Email verification"]
  node_auth_profile["Account profile"]
  node_auth_logic["Auth services<br/>[auth.service.js]"]
  node_auth_store["Auth repositories<br/>[auth.repository.js]"]
end

subgraph group_menu["Menu and restaurants"]
  node_menu_api["Menu API<br/>[index.js]"]
  node_menu_search["Menu search"]
  node_restaurant_search["Restaurant search"]
  node_restaurant_data["Restaurant queries"]
  node_battle["Menu battles"]
  node_battle_logic["Battle logic<br/>[battle.service.js]"]
  node_mukburim["Meal records"]
end

subgraph group_user["User services"]
  node_user_api["User API<br/>[index.js]"]
  node_user_profile["Profile management"]
  node_meal_alerts["Meal alerts"]
  node_recommendations["Recommendation settings"]
  node_recommend_logic["Recommendation logic"]
  node_menu_client["Menu API client<br/>[menu.client.js]"]
  node_backend_user_meal_service["Meal alert service"]
end

subgraph group_infra["Data and integrations"]
  node_mysql[("MySQL")]
  node_redis[("Redis cache")]
  node_s3[("AWS S3")]
  node_embedding["Embedding recommender"]
end

node_client(("Frontend client"))

node_client -->|"sends requests"| node_gateway_app
node_gateway_app -->|"routes requests"| node_auth_api
node_gateway_app -->|"routes requests"| node_menu_api
node_gateway_app -->|"routes requests"| node_user_api
node_auth_api -.->|"dispatches to"| node_auth_flows
node_auth_api -.->|"dispatches to"| node_auth_email
node_auth_api -.->|"dispatches to"| node_auth_profile
node_auth_flows -.->|"delegates to"| node_auth_logic
node_auth_logic -->|"queries users"| node_auth_store
node_auth_profile -->|"uses services"| node_auth_logic
node_menu_api -.->|"dispatches to"| node_menu_search
node_menu_api -.->|"dispatches to"| node_restaurant_search
node_restaurant_search -->|"calls search"| node_restaurant_data
node_menu_api -.->|"dispatches to"| node_battle
node_battle -->|"calls battle logic"| node_battle_logic
node_menu_api -.->|"provides meal records"| node_mukburim
node_user_api -.->|"dispatches to"| node_user_profile
node_user_api -.->|"dispatches to"| node_meal_alerts
node_meal_alerts -->|"calls settings"| node_backend_user_meal_service
node_user_api -.->|"dispatches to"| node_recommendations
node_recommendations -->|"calls service"| node_recommend_logic
node_recommend_logic -->|"fetches menu data"| node_menu_client
node_recommendations -->|"posts excluded IDs"| node_menu_api
node_auth_api -.->|"persists service data"| node_mysql
node_menu_api -.->|"persists service data"| node_mysql
node_user_api -.->|"persists service data"| node_mysql
node_embedding -.->|"caches recommendations"| node_redis
node_menu_api -.->|"uses storage"| node_s3
node_embedding -.->|"supports recommendations"| node_menu_api

click node_gateway_app "https://github.com/team-omechu/omechu-server/blob/develop/backend/default_container/index.js"
click node_auth_api "https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/index.js"
click node_auth_flows "https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/controllers/login.controller.js"
click node_auth_email "https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/controllers/email.controller.js"
click node_auth_profile "https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/controllers/mypage.controller.js"
click node_auth_logic "https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/services/auth.service.js"
click node_auth_store "https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/repositories/auth.repository.js"
click node_menu_api "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/index.js"
click node_menu_search "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/controllers/menuSearch.controller.js"
click node_restaurant_search "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/controllers/getSearchRestaurant.controller.js"
click node_restaurant_data "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/repositories/getSearchRestaurant.repository.js"
click node_battle "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/controllers/battle.controller.js"
click node_battle_logic "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/services/battle.service.js"
click node_mukburim "https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/services/mukburim.service.js"
click node_user_api "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/index.js"
click node_user_profile "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/controllers/profile.controller.js"
click node_meal_alerts "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/controllers/mealAlert.controller.js"
click node_recommendations "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/controllers/recommend.management.controller.js"
click node_recommend_logic "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/services/recommendManagement.service.js"
click node_menu_client "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/clients/menu.client.js"
click node_backend_user_meal_service "https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/services/mealAlert.service.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_gateway_app,node_client toneBlue
class node_auth_api,node_auth_flows,node_auth_email,node_auth_profile,node_auth_logic,node_auth_store toneAmber
class node_menu_api,node_menu_search,node_restaurant_search,node_restaurant_data,node_battle,node_battle_logic,node_mukburim toneMint
class node_user_api,node_user_profile,node_meal_alerts,node_recommendations,node_recommend_logic,node_menu_client,node_backend_user_meal_service toneRose
class node_mysql,node_redis,node_s3,node_embedding toneIndigo
```

## Components

### API gateway

- [Request router](https://github.com/team-omechu/omechu-server/blob/develop/backend/default_container/index.js): `backend/default_container/index.js`

### Authentication

- [Auth API](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/index.js): `backend/auth/src/index.js`
- [Login and OAuth](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/controllers/login.controller.js): `backend/auth/src/controllers/login.controller.js`
- [Email verification](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/controllers/email.controller.js): `backend/auth/src/controllers/email.controller.js`
- [Account profile](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/controllers/mypage.controller.js): `backend/auth/src/controllers/mypage.controller.js`
- [Auth services](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/services/auth.service.js): `backend/auth/src/services/auth.service.js`
- [Auth repositories](https://github.com/team-omechu/omechu-server/blob/develop/backend/auth/src/repositories/auth.repository.js): `backend/auth/src/repositories/auth.repository.js`

### Menu and restaurants

- [Menu API](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/index.js): `backend/menu/src/index.js`
- [Menu search](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/controllers/menuSearch.controller.js): `backend/menu/src/controllers/menuSearch.controller.js`
- [Restaurant search](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/controllers/getSearchRestaurant.controller.js): `backend/menu/src/controllers/getSearchRestaurant.controller.js`
- [Restaurant queries](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/repositories/getSearchRestaurant.repository.js): `backend/menu/src/repositories/getSearchRestaurant.repository.js`
- [Menu battles](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/controllers/battle.controller.js): `backend/menu/src/controllers/battle.controller.js`
- [Battle logic](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/services/battle.service.js): `backend/menu/src/services/battle.service.js`
- [Meal records](https://github.com/team-omechu/omechu-server/blob/develop/backend/menu/src/services/mukburim.service.js): `backend/menu/src/services/mukburim.service.js`

### User services

- [User API](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/index.js): `backend/user/src/index.js`
- [Profile management](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/controllers/profile.controller.js): `backend/user/src/controllers/profile.controller.js`
- [Meal alerts](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/controllers/mealAlert.controller.js): `backend/user/src/controllers/mealAlert.controller.js`
- [Recommendation settings](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/controllers/recommend.management.controller.js): `backend/user/src/controllers/recommend.management.controller.js`
- [Recommendation logic](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/services/recommendManagement.service.js): `backend/user/src/services/recommendManagement.service.js`
- [Menu API client](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/clients/menu.client.js): `backend/user/src/clients/menu.client.js`
- [Meal alert service](https://github.com/team-omechu/omechu-server/blob/develop/backend/user/src/services/mealAlert.service.js): `backend/user/src/services/mealAlert.service.js`

### Data and integrations

- **MySQL**
- **Redis cache**
- **AWS S3**
- **Embedding recommender**

### Other components

- **Frontend client**

## Connections

- Frontend client → Request router: sends requests
- Request router → Auth API: routes requests
- Request router → Menu API: routes requests
- Request router → User API: routes requests
- Auth API → Login and OAuth: dispatches to
- Auth API → Email verification: dispatches to
- Auth API → Account profile: dispatches to
- Login and OAuth → Auth services: delegates to
- Auth services → Auth repositories: queries users (evidence: `backend/auth/src/services/auth.service.js`)
- Account profile → Auth services: uses services (evidence: `backend/auth/src/controllers/mypage.controller.js`)
- Menu API → Menu search: dispatches to
- Menu API → Restaurant search: dispatches to
- Restaurant search → Restaurant queries: calls search
- Menu API → Menu battles: dispatches to
- Menu battles → Battle logic: calls battle logic (evidence: `backend/menu/src/controllers/battle.controller.js`)
- Menu API → Meal records: provides meal records
- User API → Profile management: dispatches to
- User API → Meal alerts: dispatches to
- Meal alerts → Meal alert service: calls settings (evidence: `backend/user/src/controllers/mealAlert.controller.js`)
- User API → Recommendation settings: dispatches to
- Recommendation settings → Recommendation logic: calls service (evidence: `backend/user/src/controllers/recommend.management.controller.js`)
- Recommendation logic → Menu API client: fetches menu data (evidence: `backend/user/src/services/recommendManagement.service.js`)
- Recommendation settings → Menu API: posts excluded IDs (evidence: `backend/user/src/controllers/recommend.management.controller.js`)
- Auth API → MySQL: persists service data
- Menu API → MySQL: persists service data
- User API → MySQL: persists service data
- Embedding recommender → Redis cache: caches recommendations
- Menu API → AWS S3: uses storage
- Embedding recommender → Menu API: supports recommendations
