How rsrini7/notification-sse works
Project type and purpose
• This is a full-stack notification system consisting of a Spring Boot backend microservice and two React frontends (Admin UI and User UI).
• It provides real-time, in-app, broadcast, user-specific, and critical (email + in-app) notifications, leveraging Kafka for async processing and SSE for live updates.
File structure
• Top-level directories:
• backend/ – Spring Boot application
• frontend/admin-ui/ – React Admin UI
• frontend/user-ui/ – React User UI
• scripts/ + root scripts – helpers for Docker, Kafka, startup
• Key configuration/build files:
• backend/pom.xml, backend/Dockerfile, docker-compose.yml
• frontend/*/package.json, Dockerfiles
• application.yml, data.sql, schema.sql in backend/src/main/resources
• Patterns:
• MVC controllers, service, repository layers in backend
• Kafka consumers and producers for event-driven processing
• SSE config for push notifications
• JWT security filters
README for additional insights
• Confirms architecture: REST APIs, Kafka topics (notifications, broadcast-notifications, critical-notifications), SSE endpoint (/api/notifications/events?token=…), email via MailCrab.
• Outlines flows: Admin/User → REST → Backend → (DB + Kafka) → Consumers → SSE + Email.
Essential architectural elements
• Detail the three Kafka topics and their consumers
• SSE endpoint and JWT token flow
• Fallback to database queries for history
• Email flow for critical notifications
• Components logically (e.g., “Backend Microservice”) but expand on sub-components for clarity