How du411/chicknotify works
Main Components
A. External Services Layer:
• Chickpt.com (Job Source)
• AWS Lambda (Scraping Service)
• Notification Channels (Email, Discord, Telegram)
B. Core Application Components:
• FastAPI Application Server
• PostgreSQL Database
• Redis Cache/Pub-Sub System
[External Sources] → [Application Core] → [Notification Destinations]
Detailed Component Breakdown
A. Data Flow Section:
[Chickpt.com] → [AWS Lambda Scraper] → [Redis Pub/Sub] → [FastAPI Backend]
B. Core Application Section:
FastAPI Backend:
• API Layer (Routers)
• Service Layer
• Repository Layer
• Model Layer
C. Storage Section:
[PostgreSQL] ← → [FastAPI Backend] ← → [Redis]
Key Relationships to Highlight
A. Data Flow:
• Lambda scraper to Redis pub/sub
• Redis pub/sub to notification service
• User subscriptions to notification matching
B. Service Dependencies:
• Authentication flow
• Subscription management
• Job matching system
• Notification dispatch
Specific Implementation Details
Key services based on the file structure:
• JobService (app/services/job_service.py)
• NotificationService (app/services/notification_service.py)
• KeywordRankingService (app/services/keyword_ranking_service.py)
• ScraperService (app/services/scraper_service.py)
Database Schema Overview
Main entities:
• Users
• Jobs
• Notifications
• Subscriptions
• NotificationTypes
• SubscriptionItems
Additional Elements
A. Infrastructure Components:
• Docker containers
• Alembic migrations
• Environment configurations
B. Security Layer:
• JWT Authentication
• Security dependencies
Key Considerations:
Monitoring and logging points
Remember to emphasize:
• The event-driven nature of the notification system
• The separation of concerns in the service layer
• The role of Redis in both caching and pub/sub
• The extensibility of the notification system
This will provide a complete picture of the system while maintaining clarity and usefulness for development and maintenance purposes.