How hetsuthar028/restaurant-app-wt works
Project type and purpose
• This is a full-stack MERN (MongoDB, Express, React, Node.js) web application called “Foodie – Restaurant App.”
• Purpose: Allow end users to browse, filter, and view menu items; allow admin users to add, edit, and delete menu items; support authentication, session management, image upload, i18n, pagination, and filtering.
File structure
• Top-level folders:
• client/ – React front-end
• server/ – Express/Node.js back-end
• screenshots/ – sample UI images
• client/: Contains public assets (i18n JSON files for multiple languages), React components organized by feature (auth, home, menu-item, navbar, etc.), routing, context, theming, and utility functions.
• server/: Contains Express entry point, middleware modules (authentication, validation, logging), route definitions, Mongoose models (Category, MenuItem, User), a job queue module, and utility modules (API errors, Redis client, session data).
• Configuration/build files: package.json in both client and server, .gitignore, README.md.
README for additional insights
• Confirms tech stack: React + MUI UI layer, Node.js + Express API layer, MongoDB for persistence, Redis for session caching, Firebase for image storage, JWT for auth tokens.
• Features: Admin menu management, user auth/authorization, OTP email verification, Google/Facebook sign-in, session management, soft deletes, error handling, i18n, pagination/filtering, logger middleware, file upload to Firebase.
Elements
• Clear labels: Name each component (e.g., “AuthRouter,” “MenuItemService,” “Redis Session Store”).
• UI → API (HTTP requests)
• API → DB/Cache (read/write)
• API → External services
• API → JobQueue → external or back into DB
• Rectangles for services
• Clouds for external services (Firebase, Google OAuth, SMTP)
Detailed breakdown
• “React App (i18n, MUI, context, router)”
• “Express App”
• Inside: Routers (auth, menu-items, categories, upload-image, otp), Middleware chain (validate-token, isSessionActive, user-validator, menu-item-validator), Error Handler
• “jobQueue” (background tasks)
• “ApiError, redisClient, sessionData”
• External (purple clouds):
• Firebase Storage
• Email/SMTP
• Google/Facebook OAuth endpoints
• Front-end → Express Routers
• Routers → Services → MongoDB/Redis
• Upload route → Firebase
• Auth routes ↔ OAuth providers
• OTP route → Email service
• Services → jobQueue → DB or external