How jaideepbose51/theverse-hackon5-ecotrustpay works
Project type and purpose
• This is a full-stack, multi-tenant e-commerce platform (“EcoCommerce”) with three separate React-based SPAs (Customer, Seller, Admin) talking to a central Node.js/Express REST API.
• Purpose: Enable three roles—end users (shopping), sellers (product management), and administrators (platform management)—to interact via authenticated API endpoints backed by MongoDB and Cloudinary.
File structure
• Top-level directories:
– backend: Express app subdivided into config, controller, middleware, model, routes, utils
– frontend: Customer SPA (React + Vite + Tailwind + Context API)
– seller: Seller SPA (React + Vite + Tailwind)
– admin: Admin SPA (React + Vite + Tailwind)
• Patterns:
– Backend follows MVC-style separation: routes → controllers → models (Mongoose).
– Shared middleware for authentication (JWT), error-handling, file uploads (Multer).
– Frontends each follow component/page hierarchy under src/, use React Router, global state or context for user sessions.
• Config & deployment files: .env references for backend URL, Cloudinary, MongoDB, JWT secret; Vite configs, Tailwind configs.
README for additional insights
• RESTful API endpoints grouped by role (/api/user, /api/seller, /api/admin)
• JWT-based auth flows, role-based middleware (authUser, authSeller, authAdmin)
• Third-party integration: Cloudinary for image storage
• Feature set: Cart, orders, eco-stats, product verification, report export
a. Main components
1) Customer SPA (React/Vite)
2) Seller SPA (React/Vite)
3) Admin SPA (React/Vite)
4) API Server (Node.js/Express)
– Routes & Controllers
– Middleware (Auth, Error Handler, Multer)
– Models (Mongoose schemas)
5) Database: MongoDB (hosted)
6) External service: Cloudinary (image upload/storage)
b. Relationships & interactions
– Each SPA communicates over HTTPS to the API Server’s REST endpoints.
– API Server persists and retrieves data from MongoDB.
– For file uploads (product images, seller docs), API Server uses Multer → Cloudinary SDK.
– JWT tokens are issued by the API Server upon login and attached by SPAs on subsequent calls.
c. Architectural patterns & design principles
– Separation of Concerns: SPAs vs. API vs. Data layer
– MVC-style organization in the backend
– Role-based access control enforced by middleware
– API contracts documented in README for consistency
– Client-side state management (Context API in Customer SPA)
d. Key technologies, frameworks, libraries
– Backend: Node.js, Express, Mongoose, Multer, jsonwebtoken, Cloudinary SDK
– Frontends: React, Vite, Tailwind CSS, React Router, Context API
– Database: MongoDB (URI via ENV)
– Auth: JWT, role-based middleware
Detail without over-complication
• Every major component and its dependencies: frontends, API modules, DB, external services.
• Don’t hesitate to break the backend into sub-components (e.g., Auth, Catalogue, User Controllers) if it improves clarity.