How body661/shoppio-api works
Project type and purpose
• This is a monolithic, backend-only e-commerce API built with Node.js and Express. It provides REST endpoints for users, products, orders, carts, coupons, reviews, etc., backed by MongoDB, with integrations for file uploads (images), payments (Stripe), email (Nodemailer/Handlebars), security middleware (helmet, HPP, XSS-clean), rate limiting, and JWT authentication.
File structure
• Top level:
• server.mjs – application entry point
• config/db.mjs – database initialization
• .env template
• Routes/ – HTTP route definitions (each resource in its own file)
• controllers/ – business-logic handlers invoked by routes
• middlewares/ – cross-cutting concerns (error handling, validation, image upload/processing)
• models/ – Mongoose schemas for each resource
• templates/ – email templates for welcome, password reset, etc.
• utils/ – shared helpers (JWT signing, API errors, pagination, sanitization, email sending)
README for additional insights
• Technology stack: Node.js, Express, MongoDB/Mongoose, AWS (for file storage), Stripe, JWT, CORS, rate limiting, data-sanitization tools, email via Nodemailer + Handlebars.
• Feature list confirms core components: Authentication/Authorization, Image Upload & Processing, Email Notification, Payment Processing, Security hardening.
Main components & interactions
a. Components
1. Client / Frontend Application
3. Express.js App (one or more instances)
– Routes Layer
– Middleware Layer (Validation, Auth, Rate-Limit, CORS, Security)
– Controllers / Service Layer
– Utils (JWT, Email, Error Handling, Sanitization)
4. MongoDB Atlas (or self-hosted)
5. AWS S3 (for image storage)
6. Stripe Payment Service
7. SMTP / Email Service (e.g., AWS SES)
b. Relationships & Data Flows
• Client → HTTP(S) → Load Balancer → Express Routes
• Route → Validator Middleware → Auth Middleware
• Auth Middleware → Controller
• Controller → Model (Mongoose ORM) → MongoDB
• Controller → Utils.sendEmail → Email Service
• Controller → Stripe SDK → Stripe API
• Image Upload Route → Multer → Sharp → AWS S3
c. Architectural Patterns & Principles
– Layered Architecture: Presentation (routes), Application (controllers), Data (models)
– Separation of Concerns: validation, business logic, file processing, error handling in dedicated middleware/modules
– Externalized configuration via environment variables
– Stateless JWT for auth, enabling horizontal scaling
d. Key Technologies
– Express.js: routing & middleware
– Mongoose: MongoDB ODM
– Multer & Sharp: file upload & processing
– AWS SDK: S3 storage (images)
– Stripe Node.js SDK: payments
– Nodemailer + Handlebars: templated emails
– Helmet, HPP, XSS-clean, cors, express-rate-limit: security
Detailed element list
– Client (browser/mobile)
– [Optional] Load Balancer / API Gateway
– Express.js Instances
• Routes: /api/auth, /api/users, /api/products, etc.
• Middleware Chain: validatorMiddleware → authMiddleware → errorMiddleware
• Controllers: AuthController, ProductController, OrderController, etc.
• Utils: signJWT, sendEmail, apiError, apiFeatures
– MongoDB (collections for users, products, orders, carts, reviews, etc.)
– AWS S3 bucket for image storage
– Stripe API for payment processing
– SMTP/SES for email notifications
– Config Service: environment variables loader