How tienkim9920/cnpm-shopping works
Project Type & Purpose
• This is a full-stack e-commerce web application for selling clothing, consisting of:
• An Admin SPA (ReactJS) for back-office management (admin_app).
• A Client SPA (ReactJS) for shoppers (client_app).
• A RESTful API and WebSocket server (NodeJS/Express, MongoDB via Mongoose, mailer, Socket.io) providing data, authentication, live chat, email notifications, and integrations (server_app).
Core Components
a. Admin Frontend
• Built with ReactJS (admin_app/src).
• Consumes admin-scoped API routes (/api/admin/…).
• Bundles static assets, SCSS, charts, maps, datatables for dashboards.
b. Client Frontend
• Built with ReactJS (client_app/src).
• Uses Redux for state (cart, session, search).
• Integrates with e-commerce APIs, payment UI (PayPal, MoMo), Google Maps for delivery cost, live chat (Messenger plugin).
c. Backend API & Real-Time
• Express server (server_app/index.js).
• Router modules under server_app/API/Router and controllers under server_app/API/Controller.
• Socket.io for live chat (as per “Socket” in README).
• Nodemailer for order confirmation emails.
d. Database
• MongoDB accessed via Mongoose models (server_app/Models/*.js).
• Implements entities: User, Product, Category, Order, Detail_Order, Comment, Coupon, Permission, Delivery, Payment, Favorite, Note.
e. External Services
• Payment Gateways: PayPal, MoMo.
• Email: SMTP via Nodemailer.
• Maps: Google Maps API for distance-based delivery cost.
• Chat: Facebook Messenger plugin + Socket.io.
Relationships & Data Flow
• Client and Admin frontends ←→ API (HTTPS REST calls + WebSocket).
• API ←→ MongoDB (CRUD via Mongoose).
• API → SMTP Server (order confirmation emails).
• API → Payment Gateway (redirect/callback).
• Client → Maps API (JS SDK) for delivery estimation.
• Client ↔ Messenger Plugin (embedded chat widget) or direct WebSocket.
Architectural Patterns & Principles
• Three-Tier Architecture: Presentation (SPAs) / Business Logic (Express) / Data (MongoDB).
• Module Separation: controllers, routers, models.
• Context & State Management: React Context for auth (admin), Redux for client shopping state.
• RESTful Routing: clearly namespaced endpoints (e.g., /api/product, /api/admin/product).
• Real-Time Messaging: Socket.io or FB Messenger for live chat.
• Scalability: separate frontends allow independent deployment; stateless API servers.
• Security: permission model (roles), JWT or session via Auth context.