RapidReserve-Platform Documentation

Overview

RapidReserve-Platform is a scalable, event-driven ticket booking platform built using Spring Boot 3. It follows a microservices architecture with asynchronous communication via Apache Kafka, utilizes MySQL for persistent storage, and employs Flyway for database migrations. Authentication and authorization are managed using Keycloak. The system is designed for real-time event and ticket management, providing resilience and high performance.

Technology Stack

• Spring Boot 3: Rapid development of robust microservices.
• Apache Kafka: Event streaming and asynchronous communication.
• Keycloak: Centralized authentication and authorization.
• Resilience4j: Microservices resilience, circuit breaking, retries.
• MySQL: Reliable, scalable relational database.
• Flyway: Automated, versioned database migrations.
• Spring Cloud Gateway: API Gateway and traffic management.
• Docker: Containerization and deployment of all services.

---

Architecture

The platform is composed of several microservices:

• API Gateway: Central entry point for all requests, routing them to appropriate services.
• Inventory Service: Manages events, venues, and ticket inventories.
• Booking Service: Handles customer bookings and orchestrates booking events.
• Order Service: Responsible for managing orders.

Communication between services is handled asynchronously through Apache Kafka, enhancing scalability and resilience.

Microservices Breakdown

1. API Gateway

• Location: /api-gateway
• Purpose: Serves as the single entry point for client requests, forwarding them to the respective microservice.
• Technology: Spring Cloud Gateway.

2. Inventory Service

• Location: /inventory-service
• Purpose: Manages the inventory of events and venues.
• Entities:
  • Venue: Stores venue details such as name, address, total capacity.

3. Booking Service

• Location: /booking-service
• Purpose: Handles customer bookings and publishes booking events to Kafka.
• Entities:
  • Customer: Represents a booking customer.

4. Order Service

• Location: /order-service
• Purpose: Manages customer orders.

Highlighted Features

• Microservices Architecture
  Decoupled, independently deployable services for agility and scalability.

• Event-Driven Communication
  Asynchronous service interaction via Apache Kafka for real-time operations and loose coupling.

• Authentication & Authorization
  Keycloak integration ensures secure, role-based access across all services.

• Resilience & Fault Tolerance
  Resilience4j provides advanced circuit breaker, retry, and rate limiter patterns—ensuring high reliability under load.

• Database Management
  MySQL for persistent data storage, with Flyway for automated schema migrations.

• API Gateway
  Spring Cloud Gateway enables unified routing, monitoring, and security for all APIs.

• Real-Time Inventory
  Centralized tracking of event capacity and ticket availability.

• Scalable Order Processing
  Automated, reliable workflow from booking to payment confirmation.

---

Getting Started

1. Clone the Repository

   git clone https://github.com/SAdhikary2/RapidReserve-Platform.git

2. Set Up MySQL Database

   • Create databases for each microservice .
   • Configure connection credentials in each service's application.properties.

3. Run Keycloak for Authentication

   • Download and start Keycloak server.
   • Configure realms, clients, and users as needed.

4. Start Kafka Broker

   • Download and run Apache Kafka.
   • Ensure the broker is running and accessible to microservices.

5. Build and Start Services

   • Use Maven or Gradle to build each service.
   • Start each microservice individually (API Gateway, Inventory Service, Booking Service, Order Service).

Folder Structure

• api-gateway/ : API Gateway microservice.
• inventory-service/ : Inventory management microservice.
• booking-service/ : Booking microservice.
• order-service/ : Order processing microservice.

Each service contains its own source code, configuration, and resources.

API Flows

1. User Authentication

   • Users authenticate via Keycloak before accessing APIs.

2. Event Listing

   • API Gateway routes requests to Inventory Service to list available events and venues.

3. Booking a Ticket

   • User submits booking request via API Gateway.
   • Booking Service validates customer, checks inventory, creates booking, and publishes a booking event.

4. Order Processing

   • Order Service listens for booking events and confirms order.