How vinayakrevankar/auction-house-contest works
Project Overview
• The application (“CS509 Auction House”) is designed to handle multiple auction-related use cases such as adding and managing items, bid placement, administrative actions, and reports generation.
• The backend is organized using a serverless architecture that leverages AWS Lambda (see the serverless.yml file) for its functions.
• An OpenAPI schema is provided (spec.yaml) for API specifications and is used to ensure consistent communication between the frontend and the backend.
Main Components
a. Frontend (Client)
• React application (located in the frontend directory) including components like LandingPage, AdminDashboard, BuyerDashboard, SellerDashboard, and various modal components (LoginModal, SignupModal, etc.).
• That the frontend utilizes API helper modules (under frontend/src/api) to communicate with the backend services.
• Role of the React application in managing state (authentication via AuthContext) and presenting views to different user roles.
b. Backend (Serverless/API Layer)
• The backend code is structured into different use-case-specific modules (e.g., manage-admin, manage-buyer, manage-item, manage-seller, manage-user) as well as common modules (security, util, and API-related files).
• Additional supporting services such as API schemas, constants, and middleware for authentication/security (from backend/src/security).
c. External Services and Infrastructure
• AWS Lambda: Represent how the serverless functions are deployed via AWS using the serverless framework (serverless.yml).
• API Gateway (implied via serverless deployment): Show how the frontend interacts with the backend endpoints.
• AWS S3: If it’s part of static content delivery for the frontend or storage, include a note based on the serverless.yml configuration.
• GitHub Actions: Include a node labeled “CI/CD Pipeline” from the .github/workflows directory to represent automated deployment (commit/merge notifications, deployment to serverless environments, etc.).
• OpenAPI Documentation: Reference the spec.yaml which governs the API contracts between the frontend and backend.
Relationships and Interactions
• Frontend sends API requests (REST calls dictated by the OpenAPI spec) to the backend API Gateway and, subsequently, to the appropriate AWS Lambda functions.
• Backend Lambda functions interact with internal services (like security middleware for authentication and forensics report generation) based on dedicated use cases.
• CI/CD pipelines (GitHub Workflows) automatically trigger deployments to the serverless infrastructure.
Architectural Patterns and Design Principles
• Modular separation: The backend is logically divided into modules based on functionality (i.e., separate directories for Admin, Buyer, Seller, and User management).
• Use of a serverless architecture to simplify deployment and scaling.
• For the frontend, note the component-based architecture of React which supports modular code reuse and separation of concerns.