How seadmustafa/jobfinder works
Project type and purpose
• Type: A backend-only Spring Boot integration service (no UI) that fetches job postings, analyzes them via AI, stores them in a database, and pushes alerts via WhatsApp.
• Purpose: Automate job discovery, AI-powered summarization, and real-time messaging on WhatsApp using Spring AI, Twilio, and PostgreSQL.
File structure
• MVC / Layered pattern:
• Controller layer: src/main/java/com/ai/finder/controller/JobController.java
• Service layer: multiple services in src/main/java/com/ai/finder/service
• Data access layer: src/main/java/com/ai/finder/repository + entity in entity/
• AI integration: src/main/java/com/ai/finder/ai/ChatClient, Prompt, ChatResponse
• Config: OpenApiConfig for Swagger/OpenAPI docs
• No frontend folder → purely backend microservice
• Build/deployment: pom.xml, Maven wrapper, application.properties for env injection
Extract insights from README
• Core tech: Java 17, Spring Boot, Spring AI, Twilio WhatsApp API, PostgreSQL, Maven
• Features: Web scraping job boards, summarization via OpenAI, persistence, WhatsApp delivery
• External dependencies: OpenAI API, Twilio Business API, Postgres DB
• Env vars used for secrets (DB, TWILIO, OPENAI)
Main components & interactions
a. Components:
1. JobController (REST endpoint or scheduler trigger)
2. WebScrapingService (fetch postings from external job boards over HTTP/HTML)
3. JobFinderService (orchestrates scraping → analysis → persistence → messaging)
4. JobAnalysisService (prepares prompts, calls ChatClient)
5. ChatClient (communicates with OpenAI API)
6. WhatsAppService (wraps Twilio’s WhatsApp API)
7. JobRepository / JPA + PostgreSQL (persistent store)
8. OpenAPI UI (Swagger docs via OpenApiConfig)
9. External systems: Job boards, OpenAI API, Twilio WhatsApp API, User’s WhatsApp client
b. Relationships & data flow:
1. Client (or internal scheduler) → HTTP request → JobController
2. JobController → JobFinderService
3. JobFinderService → WebScrapingService → Job postings
4. Persist raw postings → JobRepository → PostgreSQL
5. JobFinderService → JobAnalysisService → ChatClient → OpenAI API → summarized data
6. JobFinderService → WhatsAppService → Twilio WhatsApp API → end-user WhatsApp
7. Controller also exposes GET/POST endpoints for manual triggers or status checks
8. OpenAPI UI available at /swagger-ui.html
c. Architectural patterns & principles:
• Layered (Controller → Service → Repository)
• Dependency Injection (Spring-managed beans)
• Externalized configuration (env vars in application.properties)
• Single-responsibility per service (scraping vs. analysis vs. messaging)
• Integration with 3rd-party APIs via dedicated client classes
d. Key technologies:
• Spring Boot (application runtime)
• Spring AI (OpenAI integration)
• Spring Data JPA (JobRepository + PostgreSQL)
• Twilio Java SDK (WhatsAppService)
• Maven (build & dependency management)
• OpenAPI / Swagger (OpenApiConfig)