How itzminos/ceng-495-hw1 works
Project Type and Purpose
• This is a full-stack e-commerce web application built with Next.js (React) for the frontend and backend (serverless API routes), MongoDB (via Mongoose) for data persistence, and Vercel for deployment.
• It supports browsing items, user authentication/authorization (regular vs. admin), CRUD operations on items/users (admin), and rating/review functionality.
File Structure Analysis
• frontend/UI layer:
• components/ (Footer.js, ItemCard.js, Navbar.js)
• pages/ (Next.js pages: index.js, items/[id].js, cart.js, login.js, signup.js, user.js, admin.js, cancel.js, success.js)
• context/ (cardContext.js for client‐side state such as cart contents)
• public/ (static assets)
• backend/API layer (Next.js serverless functions):
• pages/api/ (auth.js, checkout.js, items.js, items/[id].js, items/[id]/reviews.js, user.js, users.js)
• data layer:
• lib/dbConnect.js (DB connection helper)
• models/ (Mongoose schemas: Item.js, Review.js, User.js)
• config & deployment:
• package.json (dependencies like next, react, mongoose, bcrypt, stripe?)
• postcss.config.mjs
• .gitignore, .vscode settings
Key Architectural Patterns
• MVC-style separation:
• Models: Mongoose schemas in models/
• Controllers: Next.js API routes in pages/api/ act as controllers handling requests/ responses
• Views: React components in pages/ and components/
• Serverless Functions: Each file under pages/api/ becomes an isolated serverless endpoint on Vercel.
• Client-side state management: React Context (cardContext.js) for shopping cart.
• Authentication/Authorization: JWT or cookie-based sessions via pages/api/auth.js guards protected pages (user.js, admin.js).
• Database cleanup logic: Cascade deletion logic in API controller or Mongoose pre/post hooks to remove related reviews.
Main Components & Interactions
• Browser (User Agent)
• Interacts with Next.js pages (SSR/SSG + client-side React)
• Calls API endpoints for data ops (login, fetch items, add review, checkout)
• Next.js Frontend
• Renders UI, holds cart state, invokes API routes via fetch/axios
• Next.js Serverless API
• pages/api/auth.js: login/signup, issue tokens or sessions
• pages/api/items*.js: CRUD on items, fetch item list/details
• pages/api/items/[id]/reviews.js: post/read reviews
• pages/api/checkout.js: payment integration (e.g., Stripe)
• pages/api/users.js & pages/api/user.js: user management, admin functions
• MongoDB (Atlas)
• Collections: users, items, reviews
• dbConnect.js manages connection pooling
• External Services
• Vercel for hosting and auto-deploy
• (Optional) Stripe or other payment gateway via checkout.js
Essential Elements to Capture
• Clear labels on each component
• UI
• Business Logic/API
• Database
• External Services
• Annotations for authentication/authorization boundaries