May 1, 2022 7:00 PM PDT
This document summarizes the design of a fitness coaching platform aimed at facilitating interactions between gym owners, trainers, and trainees. The platform will allow users to manage classes, enrollments, and notifications.
Requirements
Functional Requirements
- Users: Gym owners, trainers, trainees.
- Gym Owners: Can register rooms and trainers.
- Trainers: Can host classes (initially one-time classes).
- Payment: Future requirement; currently a good-to-have feature.
- Waiting Lists: Most gym owners have a waiting list for full classes.
Non-Functional Requirements
- Startup MVP: Designed for low traffic.
System Design
Database Design
- MySQL: Chosen due to expected low traffic.
- Entities:
- Room: RoomID, location, etc.
- Class: classID, roomID, limit, peopleID, startTime, endTime.
- Enrollment: id, peopleID, classID, status (succeed/fail), enabled, CRUD operations.
- Account: peopleID, name, email, type, etc.
- Trainer: registered status.
Class Management
- Host Class: Trainers can choose a classroom and check availability.
- Room Availability: Check time slots for free rooms.
- Class Creation: Ability to create new classes (weekly/monthly).
- Class Updates: Check room availability before publishing updates.
- Cancellation: Classes can be canceled before they start.
Enrollment Management
- Trainee Registration: Users can register and enroll in classes.
- Status Management: Track enrollment status and manage waitlists.
- Notifications: Notify users on waiting lists when spots become available.
Timing and Notifications
- RabbitMQ: Considered for managing timing events and notifications.
- Dead Letter Queue: For handling expired waitlist entries.
- Batch Service: Runs every hour to manage pending statuses and class availability.
Future Work
- Online Support: Explore options for supporting unlimited class sizes.
- Payment Features: Implement payment processing and exception handling.
- Microservices: Consider transitioning to a microservices architecture.
- Load Balancing: Implement load balancing for web and mobile applications.
Design Considerations
- High Availability: Ensure the system is available and responsive.
- Scalability: Plan for scaling from a few gyms to potentially 1 million users.
- Data Management: Consider using caching solutions and message queues for efficiency.
- API Design: Evaluate trade-offs between REST and Graph APIs.
Challenges
- Room vs Class Management: Determine how to reserve rooms and manage class schedules effectively.
- Conflict Detection: Implement mechanisms to prevent scheduling conflicts in the database.
Conclusion
The fitness coaching platform design focuses on providing essential features for gym owners, trainers, and trainees while considering future scalability and performance enhancements.