{"id":2868,"date":"2025-09-12T17:04:08","date_gmt":"2025-09-12T17:04:08","guid":{"rendered":"https:\/\/codeinsightacademy.com\/blog\/?p=2868"},"modified":"2025-09-12T17:13:08","modified_gmt":"2025-09-12T17:13:08","slug":"e-commerce","status":"publish","type":"post","link":"https:\/\/codeinsightacademy.com\/blog\/projects\/e-commerce\/","title":{"rendered":"E-Commerce"},"content":{"rendered":"\n
\"\"<\/a><\/figure>\n\n\n\n

PRD: E-commerce CRUD Application<\/h3>\n\n\n\n

This PRD is intentionally generic and framework-agnostic for freshers. It supports MySQL as the primary database, with interchangeable backends (Python Flask\/FastAPI, Java Spring Boot, Node Express) and frontends (Vanilla JS, React, Next.js).<\/p>\n\n\n\n

\n\n\n\n

1) Overview<\/h2>\n\n\n\n
  • Goal: Build a simple e-commerce CRUD app with products, carts, and three roles: Admin, Seller, Customer.<\/li>
  • Core features:<\/li>
  • List Products<\/li>
  • Product Details<\/li>
  • Add to Cart<\/li>
  • Update Product in Cart<\/li>
  • Delete Product from Cart<\/li>
  • List Carts<\/li>
  • Constraints:<\/li>
  • Database: MySQL<\/li>
  • Backend: Python (Flask or FastAPI) or Java Spring Boot or Node Express<\/li>
  • Frontend: Vanilla JS or React or Next.js<\/li>
  • Clean separation of concerns and RESTful API design<\/li>
  • Authentication and Role-Based Access Control (RBAC)<\/li><\/ul>\n\n\n\n
    \n\n\n\n

    2) Personas and Roles<\/h2>\n\n\n\n
    • Admin<\/li>
    • Manages users and sellers<\/li>
    • Can CRUD any product<\/li>
    • Can view all carts and audit activity<\/li>
    • Seller<\/li>
    • Manages own products only<\/li>
    • Can view orders that include their products (if implemented as a stretch)<\/li>
    • Customer\/Buyer<\/li>
    • Browses products<\/li>
    • Manages own cart<\/li>
    • Checks out cart (stretch)<\/li><\/ul>\n\n\n\n

      RBAC summary:<\/p>\n\n\n\n

      • Admin: Full access<\/li>
      • Seller: CRUD only own products, read others\u2019 product listings<\/li>
      • Customer: Read product listings, manage own cart<\/li><\/ul>\n\n\n\n
        \n\n\n\n

        3) Scope and Features<\/h2>\n\n\n\n

        3.1 Product Management<\/h3>\n\n\n\n
        • Create Product<\/li>
        • Read Product List<\/li>
        • Read Product Detail<\/li>
        • Update Product<\/li>
        • Delete Product<\/li>
        • Constraints:<\/li>
        • Seller can only modify products they own<\/li>
        • Admin can modify any product<\/li>
        • Customers cannot modify products<\/li><\/ul>\n\n\n\n

          3.2 Cart Management<\/h3>\n\n\n\n
          • Add to Cart<\/li>
          • Update Product Quantity in Cart<\/li>
          • Remove Product from Cart<\/li>
          • View Cart<\/li>
          • Constraints:<\/li>
          • One open cart per customer at a time<\/li>
          • If cart does not exist, create on first add<\/li>
          • Quantity must be positive integer<\/li>
          • Enforce stock minimum of 0 on update (no negative stock; oversell prevention optional)<\/li><\/ul>\n\n\n\n

            3.3 Authentication and Authorization<\/h3>\n\n\n\n
            • Register\/Login<\/li>
            • Session or JWT-based auth<\/li>
            • Role assignment at registration by Admin (students may seed roles)<\/li>
            • Middleware to enforce role-based access<\/li><\/ul>\n\n\n\n

              3.4 Non-Goals (Out of Scope for MVP)<\/h3>\n\n\n\n
              • Payments and checkout processing<\/li>
              • Inventory reservations and order lifecycle<\/li>
              • Reviews\/ratings, wishlists<\/li>
              • Media storage beyond product image URL<\/li>
              • Internationalization, taxes, shipping<\/li><\/ul>\n\n\n\n
                \n\n\n\n

                4) Functional Requirements<\/h2>\n\n\n\n

                4.1 User Stories<\/h3>\n\n\n\n
                • As a Customer, I can view a list of products with pagination and search.<\/li>
                • As a Customer, I can view product details.<\/li>
                • As a Customer, I can add a product to my cart, update quantities, and remove items.<\/li>
                • As a Customer, I can view my current cart and total cost.<\/li>
                • As a Seller, I can create, update, and delete my products.<\/li>
                • As a Seller, I can view only my products in a \u201cMy Products\u201d view.<\/li>
                • As an Admin, I can manage all products and view all carts.<\/li>
                • As an Admin, I can manage users and assign roles.<\/li><\/ul>\n\n\n\n

                  4.2 API Endpoints (REST, generic)<\/h3>\n\n\n\n

                  Auth:<\/p>\n\n\n\n

                  • POST \/api\/auth\/register<\/li>
                  • POST \/api\/auth\/login<\/li>
                  • GET \/api\/auth\/me<\/li><\/ul>\n\n\n\n

                    Products:<\/p>\n\n\n\n

                    • GET \/api\/products?search=&category=&sort=&page=&pageSize=<\/li>
                    • GET \/api\/products\/:id<\/li>
                    • POST \/api\/products [Seller, Admin]<\/li>
                    • PUT \/api\/products\/:id [Owner Seller, Admin]<\/li>
                    • DELETE \/api\/products\/:id [Owner Seller, Admin]<\/li><\/ul>\n\n\n\n

                      Carts:<\/p>\n\n\n\n

                      • GET \/api\/carts\/me [Customer]<\/li>
                      • POST \/api\/carts\/me\/items body: { productId, quantity } [Customer]<\/li>
                      • PUT \/api\/carts\/me\/items\/:itemId body: { quantity } [Customer]<\/li>
                      • DELETE \/api\/carts\/me\/items\/:itemId [Customer]<\/li>
                      • (Admin-only) GET \/api\/carts to list all carts, filter by userId<\/li><\/ul>\n\n\n\n

                        Users and Roles (Admin only):<\/p>\n\n\n\n

                        • GET \/api\/users<\/li>
                        • PUT \/api\/users\/:id\/role body: { role }<\/li><\/ul>\n\n\n\n

                          Response format:<\/p>\n\n\n\n

                          • JSON objects with consistent envelope: { data, error, meta }<\/li>
                          • Use proper HTTP status codes:<\/li>
                          • 200 OK, 201 Created, 204 No Content<\/li>
                          • 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 422 Unprocessable, 500 Server Error<\/li><\/ul>\n\n\n\n

                            Validation:<\/p>\n\n\n\n

                            • Use server-side validation for all inputs<\/li>
                            • Return errors with field-level messages<\/li><\/ul>\n\n\n\n
                              \n\n\n\n

                              5) Data Model (MySQL)<\/h2>\n\n\n\n

                              Tables and key columns:<\/p>\n\n\n\n

                              • users<\/li>
                              • id PK, uuid or bigint<\/li>
                              • email unique<\/li>
                              • password_hash<\/li>
                              • role enum(\u2018ADMIN\u2019, \u2018SELLER\u2019, \u2018CUSTOMER\u2019)<\/li>
                              • name<\/li>
                              • created_at, updated_at<\/li>
                              • products<\/li>
                              • id PK<\/li>
                              • seller_id FK -> users.id<\/li>
                              • name<\/li>
                              • description TEXT<\/li>
                              • price DECIMAL(10,2)<\/li>
                              • stock INT<\/li>
                              • image_url VARCHAR(2048) NULL<\/li>
                              • category VARCHAR(255) NULL<\/li>
                              • created_at, updated_at<\/li>
                              • index(name), index(category)<\/li>
                              • carts<\/li>
                              • id PK<\/li>
                              • user_id FK -> users.id unique for active\/open cart<\/li>
                              • status enum(\u2018OPEN\u2019, \u2018CHECKED_OUT\u2019) default \u2018OPEN\u2019<\/li>
                              • created_at, updated_at<\/li>
                              • unique(user_id, status=’OPEN’) logical uniqueness enforced by application or partial index emulation<\/li>
                              • cart_items<\/li>
                              • id PK<\/li>
                              • cart_id FK -> carts.id<\/li>
                              • product_id FK -> products.id<\/li>
                              • quantity INT<\/li>
                              • unit_price DECIMAL(10,2) snapshot at add time (optional for MVP; otherwise compute from products)<\/li>
                              • unique(cart_id, product_id)<\/li>
                              • created_at, updated_at<\/li><\/ul>\n\n\n\n

                                Indexes:<\/p>\n\n\n\n

                                • FK indexes on seller_id, user_id, cart_id, product_id<\/li>
                                • Search indexes on products.name, products.category<\/li><\/ul>\n\n\n\n

                                  Referential integrity:<\/p>\n\n\n\n

                                  • ON DELETE RESTRICT for product if present in cart_items (or cascade remove cart_items on product delete for teaching simplicity; discuss trade-offs)<\/li>
                                  • ON DELETE CASCADE for cart -> cart_items<\/li><\/ul>\n\n\n\n
                                    \n\n\n\n

                                    6) Security and Auth<\/h2>\n\n\n\n
                                    • Passwords: md5 or bcrypt<\/li>
                                    • Auth: JWT or server sessions with HttpOnly cookies<\/li>
                                    • RBAC middleware:<\/li>
                                    • Admin routes: require role === ADMIN<\/li>
                                    • Seller product writes: require role === SELLER and seller_id === current_user.id<\/li>
                                    • Customer cart routes: require role === CUSTOMER and user_id === current_user.id<\/li>
                                    • Input sanitation and validation<\/li>
                                    • CORS configured for chosen frontend host<\/li>
                                    • Prevent overposting by whitelisting fields<\/li><\/ul>\n\n\n\n
                                      \n\n\n\n

                                      7) Non-Functional Requirements<\/h2>\n\n\n\n
                                      • Performance:<\/li>
                                      • Product list should return within 500 ms for 10k product dataset with indexes<\/li>
                                      • Pagination default pageSize 20<\/li>
                                      • Reliability:<\/li>
                                      • Handle concurrent cart updates gracefully<\/li>
                                      • Observability:<\/li>
                                      • Basic request logging and error logging<\/li>
                                      • Code Quality:<\/li>
                                      • Layered architecture: routes\/controllers, services, repositories\/DAOs, models<\/li>
                                      • Unit tests for services and repositories<\/li>
                                      • Minimal integration tests for core flows<\/li><\/ul>\n\n\n\n
                                        \n\n\n\n

                                        8) UX Requirements<\/h2>\n\n\n\n
                                        • Views:<\/li>
                                        • Product List: grid or table with name, price, stock, category, thumbnail<\/li>
                                        • Product Detail: name, description, price, stock, image, add-to-cart<\/li>
                                        • My Cart: line items, quantity controls, remove action, subtotal and total<\/li>
                                        • Seller Dashboard: My Products CRUD<\/li>
                                        • Admin Panel: Users list, role management, all carts view<\/li>
                                        • Accessibility:<\/li>
                                        • Semantic HTML where applicable<\/li>
                                        • Keyboard navigation for cart quantity updates<\/li>
                                        • Responsive:<\/li>
                                        • Mobile-first layout<\/li><\/ul>\n\n\n\n
                                          \n\n\n\n

                                          9) Acceptance Criteria<\/h2>\n\n\n\n

                                          Product Listing<\/p>\n\n\n\n

                                          • Given products exist, when a customer visits \/products, they see a paginated list with name, price, and image.<\/li>
                                          • Searching by name returns matching items.<\/li>
                                          • Clicking an item navigates to details.<\/li><\/ul>\n\n\n\n

                                            Product Details<\/p>\n\n\n\n

                                            • Given a product exists, details page shows name, description, price, stock, and add-to-cart button.<\/li>
                                            • If stock is 0, add-to-cart is disabled.<\/li><\/ul>\n\n\n\n

                                              Cart<\/p>\n\n\n\n

                                              • Add to cart creates an OPEN cart if none exists.<\/li>
                                              • Updating quantity reflects in totals immediately.<\/li>
                                              • Removing an item deletes row and updates total.<\/li>
                                              • Customers cannot access another user\u2019s cart.<\/li><\/ul>\n\n\n\n

                                                Seller Product CRUD<\/p>\n\n\n\n

                                                • Seller can create, edit, delete only their products.<\/li>
                                                • Attempting to modify others\u2019 products returns 403.<\/li><\/ul>\n\n\n\n

                                                  Admin<\/p>\n\n\n\n

                                                  • Can list all carts and view any product.<\/li>
                                                  • Can change user roles.<\/li><\/ul>\n\n\n\n

                                                    API<\/p>\n\n\n\n

                                                    • All endpoints return appropriate status codes and validation errors.<\/li><\/ul>\n\n\n\n
                                                      \n\n\n\n

                                                      10) Developer Guidance by Stack<\/h2>\n\n\n\n

                                                      Backend notes:<\/p>\n\n\n\n

                                                      • Flask\/FastAPI<\/li>
                                                      • Use SQLAlchemy + Alembic for migrations<\/li>
                                                      • Pydantic (FastAPI) for request\/response models<\/li>
                                                      • Spring Boot<\/li>
                                                      • Spring Security for auth, JPA\/Hibernate, Flyway\/Liquibase migrations<\/li>
                                                      • Node Express<\/li>
                                                      • TypeScript recommended, Prisma\/TypeORM\/Sequelize, Zod\/Joi validation<\/li><\/ul>\n\n\n\n

                                                        Frontend notes:<\/p>\n\n\n\n

                                                        • Vanilla JS<\/li>
                                                        • Fetch API, simple routing via hash or path<\/li>
                                                        • React<\/li>
                                                        • React Router, SWR\/React Query, controlled forms<\/li>
                                                        • Next.js<\/li>
                                                        • App Router, fetch from server components or client with SWR, API routes optional for demo<\/li><\/ul>\n\n\n\n
                                                          \n\n\n\n

                                                          11) API Contracts (Sample Schemas)<\/h2>\n\n\n\n

                                                          Product (response)<\/p>\n\n\n\n

                                                          • id: number<\/li>
                                                          • name: string<\/li>
                                                          • description: string<\/li>
                                                          • price: number<\/li>
                                                          • stock: number<\/li>
                                                          • imageUrl: string|null<\/li>
                                                          • category: string|null<\/li>
                                                          • sellerId: number<\/li><\/ul>\n\n\n\n

                                                            Cart (response)<\/p>\n\n\n\n

                                                            • id: number<\/li>
                                                            • userId: number<\/li>
                                                            • status: “OPEN” | “CHECKED_OUT”<\/li>
                                                            • items: Array<\/li>
                                                            • total: number<\/li><\/ul>\n\n\n\n

                                                              CartItem (response)<\/p>\n\n\n\n

                                                              • id: number<\/li>
                                                              • productId: number<\/li>
                                                              • quantity: number<\/li>
                                                              • unitPrice: number<\/li>
                                                              • productSnapshot: { id, name, price, imageUrl } \/\/ optional<\/li><\/ul>\n\n\n\n

                                                                Error (response)<\/p>\n\n\n\n

                                                                • error: { code: string, message: string, details?: any }<\/li><\/ul>\n\n\n\n
                                                                  \n\n\n\n

                                                                  12) Milestones<\/h2>\n\n\n\n
                                                                  • Milestone 1: DB schema and migrations ready. Seed users with roles.<\/li>
                                                                  • Milestone 2: Auth + RBAC middleware working.<\/li>
                                                                  • Milestone 3: Products API and UI list\/detail.<\/li>
                                                                  • Milestone 4: Cart API and UI end-to-end.<\/li>
                                                                  • Milestone 5: Seller product CRUD UI.<\/li>
                                                                  • Milestone 6: Admin basics: users list, role update, carts list.<\/li>
                                                                  • Milestone 7: Tests and polish.<\/li><\/ul>\n\n\n\n
                                                                    \n\n\n\n

                                                                    13) Evaluation Rubric for Students<\/h2>\n\n\n\n
                                                                    • Correctness: Meets acceptance criteria and RBAC rules<\/li>
                                                                    • Code Quality: Structure, readability, validation, error handling<\/li>
                                                                    • DB Design: Keys, indexes, constraints, migrations<\/li>
                                                                    • Security: Auth, password hashing, access controls<\/li>
                                                                    • UX: Usable flows, responsive layout, basic accessibility<\/li>
                                                                    • Tests: Coverage of core services and endpoints<\/li><\/ul>\n\n\n\n
                                                                      \n\n\n\n

                                                                      14) Stretch Goals<\/h2>\n\n\n\n
                                                                      • Checkout flow with order creation<\/li>
                                                                      • Stock decrement on checkout<\/li>
                                                                      • Product images upload to object storage<\/li>
                                                                      • Sorting, filters, categories<\/li>
                                                                      • Rate limiting and caching for product list<\/li>
                                                                      • Swagger\/OpenAPI documentation<\/li><\/ul>\n\n\n\n
                                                                        \n\n\n\n

                                                                        <\/p>\n","protected":false},"excerpt":{"rendered":"

                                                                        PRD: E-commerce CRUD Application This PRD is intentionally generic and framework-agnostic for freshers. It supports MySQL as the primary database, with interchangeable backends (Python Flask\/FastAPI, Java Spring Boot, Node Express) and frontends (Vanilla JS, React, Next.js). 1) Overview Goal: Build a simple e-commerce CRUD app with products, carts, and three roles: Admin, Seller, Customer. Core […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[32],"tags":[],"_links":{"self":[{"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/posts\/2868"}],"collection":[{"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/comments?post=2868"}],"version-history":[{"count":2,"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/posts\/2868\/revisions"}],"predecessor-version":[{"id":2872,"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/posts\/2868\/revisions\/2872"}],"wp:attachment":[{"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/media?parent=2868"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/categories?post=2868"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/codeinsightacademy.com\/blog\/wp-json\/wp\/v2\/tags?post=2868"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}