How keyurvaghani/unitedtutoring works
Based on our analysis of the file structure and README information, United Tutoring is a full-stack online tutoring platform that relies on a modern frontend built in React (under the “client” directory), a number of AWS Lambda functions (in the “lambda” directory) for its business logic and serverless backend operations, and AWS CloudFormation scripts (in the “cloud_formation” directory) to provision and manage its AWS services and infrastructure.
Main Components
• Frontend (Client): Represented by the “client” directory. This React-based application manages the user interface for both tutors and students, handling components like authentication (AuthenticatedRoute/UnAuthenticatedRoute), dashboards, profiles, and booking interactions. Include details such as:
• Pages for login, profile management, tutor availability, booking interfaces, etc.
• API calls from the client (e.g., from the “apis” directory) to the backend.
• Backend (Serverless Functions): Represent the Lambda functions that handle operations such as getting or saving profile images, booking details, tutor availability, and email notifications. These functions act as the business logic for data manipulation and interaction.
• Infrastructure & Deployment: Incorporate AWS CloudFormation scripts (e.g., “united_tutoring_backend.yml” and “united_tutoring_beanstalk.yml”) which automate the provisioning of the AWS services used. Include references to:
• AWS Lambda (for Lambda functions)
• AWS API Gateway (for exposing Lambda functions as RESTful endpoints)
• AWS Cognito (for user authentication)
• AWS DynamoDB (data store, although not seen in the file tree, mentioned in the README)
• AWS S3 (could be used for hosting assets or client static files)
• Other AWS services such as Elastic Beanstalk, EventBridge (for cronjobs), and SNS (for notifications)
Relationships & Data Flow
• User Interaction: Show the user (student/tutor) accessing the React client running in a browser.
• Authentication: Include a component for AWS Cognito managing user login and leveraging JWT tokens.
• Cronjobs & Scheduling: Illustrate that a scheduled Lambda function (via AWS EventBridge) periodically updates session status.
Architectural Patterns & Design Principles
• Serverless Architecture: Emphasize that the backend logic is implemented in distinct Lambda functions which are triggered through API Gateway endpoints.
• Infrastructure as Code: Note the use of AWS CloudFormation templates which manage the deployment and configuration of AWS resources, promoting repeatability and scalability.
• API-driven Communication: Highlight the clear API boundaries between the client and the serverless backend.