How mudassarhakim/common-debit-card works
Project type and purpose
• This is a full-stack, event-driven microservices system for managing debit-card metadata.
• It comprises two Spring Boot microservices:
• Card Repo Service (internal, Kafka consumer + MySQL + sync)
• Cards Microservice (public REST API, facade + circuit breaker + Redis cache)
File structure
• Top-level modules:
• card-repo/ – Spring Boot service, consumes Kafka events, persists to MySQL, syncs to Customer360.
• cards-service/ – Spring Boot web service, exposes REST endpoints, uses circuit breaker and Redis.
• Shared root files:
• docker-compose.yml – brings up MySQL, Kafka, Zookeeper, Redis.
• pom.xml – multi-module Maven parent.
• docs/ & postman/ – integration guides, API tests.
• Patterns visible:
• Event-driven ingestion (Spring Kafka consumer).
• Persistence via Spring Data JPA.
• DTO layering (controller-dto-entity).
• Circuit breaker (Resilience4j) in the public API.
• Docker Compose for infrastructure orchestration.
README for additional insights
• Two main microservices with clearly defined responsibilities.
• Technology stack: Java 17, Spring Boot 3, Kafka, MySQL, Redis, Resilience4j.
• Infrastructure: Docker Compose includes Kafka & Zookeeper, MySQL, Redis.
• Provides high-level flow: produce card events → card-repo consumes → store and sync → cards-service facades and serves public APIs → frontends.
Elements
• Clear labels for each component (e.g., “CardEventConsumer,” “CardController,” “MySQL”).
• From Kafka → Card Repo
• From Card Repo → MySQL
• From Card Repo → Customer360 Sync
• From Clients → Cards Service → Redis → Card Repo → Redis → Clients
• Internal service (card-repo) in blue
• Public service (cards-service) in green
• External Clients in orange
Detailed capture of essential architectural elements
• Docker Compose as the deployment boundary, with all infra components grouped under it.