How umutkarakas34/ecommerce-project works
Project type and purpose
• This is a Node.js/Express backend for an e-commerce platform.
• It exposes RESTful HTTP APIs for users, sellers, and admins.
• It uses Sequelize ORM to manage a MySQL database.
File structure
• Top‐level directory: eCommerce-backend
– app.js: entry point, wires middleware, routes, DB sync, static files, and server startup.
– routes/: defines three API routers: /admin, /seller, /user.
– controllers/: houses business logic per role (adminController, sellerController, userController).
– middlewares/: authentication layer (AuthMiddleware).
– models/: Sequelize model definitions (User, Product, Order, Cart, etc.) plus relationship.js that establishes associations.
– utility/db.js: sets up Sequelize connection to MySQL.
– public/: static assets served at /public.
– .env: environment variables for DB credentials, JWT secrets, etc.
README for additional technical insights
• Uses Express, Sequelize, MySQL.
• Enables CORS, JSON/body-parser middleware, session support, dotenv for config.
• Routes are mounted at /admin, /seller, /user.
• Database sync is optionally triggered in app.js.
• No external microservices; pure monolithic API server.
a. Main components
1. HTTP API Server (Express App)
– Route Layer (/admin, /seller, /user)
– Controller Layer (adminController, sellerController, userController)
– Middleware Layer (AuthMiddleware, cors, body-parsers, session)
2. ORM/Data Access Layer
– Sequelize models & relationship definitions
– utility/db.js (Sequelize instance)
3. Database
– MySQL instance (remote or local)
4. Static asset server
– Serving public/ via express.static
5. Configuration
– .env, dotenv module
b. Relationships & interactions
– Client (frontend or API consumer) → HTTP request → Express Route → AuthMiddleware → Controller → Sequelize Model → MySQL.
– Controller may invoke multiple models (e.g., orderController uses Order, OrderItem, Product).
– Sequelize defines associations in relationship.js, enabling JOINs.
– app.js wires routes and middleware, serves static files on /public.
c. Architectural patterns & design principles
– Layered (Presentation → Controller/Service → Data Access → Persistence)
– MVC-style separation (Express routes/controllers, Sequelize models)
– Single monolithic service (no microservices).
d. Key technologies/frameworks
– Node.js runtime
– Express (web framework)
– Sequelize (ORM)
– MySQL (relational database)
– Middleware: cors, body-parser, express-session, dotenv
Detail is key
– Route definitions (/admin, /seller, /user)
– Controller modules
– AuthMiddleware
– ORM/Sequelize configuration
– Database
– Static file serving
• Environment/config (.env) as a config block that feeds into utility/db.js and express-session setup.
• If helpful, annotate sample endpoint flows (e.g., POST /user/create-order → UserController.createOrder() → Order & OrderItem models → MySQL).