How emaohi/shifty works
Main Components
a) Core Application Components:
• Django Web Application (Main server)
• Celery Worker System
• RabbitMQ Message Broker
• Database Layer (MySQL)
• Redis Cache
• ElasticSearch Engine
b) External Services:
• Google Maps API
• Profanity API
• Holidays API
• Logo Finder Service
Client Layer
• Manager Interface
• Employee Interface
• Anonymous User Interface
Web Application Layer (Django)
• Core Module (shift management)
• Log Module (user/business management)
• Menu Module (quiz system)
Service Layer
• Authentication Service
• Shift Generation Algorithm
• Search Service
• Caching Service
• Leader Board Service
Background Processing Layer
• Celery Workers
• Task Queue (RabbitMQ)
Data Storage Layer
• MySQL Database
• Redis Cache
• ElasticSearch
External Services Layer
• Third-party APIs
• Logo Finder Service
Specific Design Elements
Use the following visual elements:
• Blue rectangles for core application components
• Green rectangles for external services
• Orange rectangles for data stores
• Purple rectangles for message queues
Key Flows to Highlight
a) Shift Management Flow:
• Shift creation/generation
• Shift swap requests
• Employee assignments
b) Background Tasks Flow:
• Holiday updates
• Email notifications
• ElasticSearch indexing
• Logo fetching
c) Caching Strategy:
• ETL to business
• Employee requests
• Manager messages
• Previous shifts
Additional Details
A separate section showing:
• Health check monitoring points
• Cache invalidation paths
• Search indexing flow
• Leader board update mechanism
Notes Section
Notes about:
• Scalability points
• Failure recovery paths
• Cache update strategies
• Algorithm selection points
Remember to highlight the key features mentioned in the README, such as the shift generation algorithm, caching strategy, and integration with external services, as these are crucial to understanding the system's architecture.