Elixir Spin - Deck Generator for Clash Royale

Elixir Spin is a robust backend application designed to generate optimized decks for Clash Royale. It leverages the official Clash Royale API to synchronize card data and provides a powerful deck generation engine with multi-level caching for high performance.

🚀 Features

• Dynamic Deck Generation: Leverages a specialized DeckRandomizerService to create balanced decks based on game-specific logic (win conditions, air counters, spells, etc.).
• API Synchronization: Real-time integration with the Clash Royale official API for card data management.
• Multi-Level Caching: Uses Caffeine for fast local memory access and Redis for distributed caching.
• Fault Tolerance: Implements Resilience4j for retries and circuit breaking on external API calls.
• Scheduled Sync: Automatically synchronizes card data daily via a cron job.
• Metric Tracking: Built-in service for monitoring application usage and performance.

🛠 Tech Stack

• Language: Java 21
• Framework: Spring Boot 3.3.4
• Database: PostgreSQL
• Caching: Redis & Caffeine
• Resilience: Resilience4j
• Utility: Lombok

📋 Prerequisites

Before running the application, ensure you have the following installed:

• Java 21 JDK or higher.
• Maven 3.9+
• PostgreSQL (running on port 4321 by default).
• Redis (optional but recommended for production-like environments).
• Clash Royale API Token: Obtain one from the Clash Royale Developer Portal.

⚙️ Configuration

The application configuration is located in src/main/resources/application.yaml.

Key properties:

• spring.datasource: Database connection settings.
• clashroyale.api.token: Your personal API token.
• card.sync.cron: Schedule for card synchronization (Default: 0 0 3 * * ?).
• resilience4j: Fault tolerance settings for the Clash Royale API integration.

🚀 Getting Started

1. Clone the repository:

   git clone https://github.com/your-repo/elixirspin.git
   cd elixirspin
   

2. Setup Database: Create a database named elixirspin in PostgreSQL.

3. Run the application:

   ./mvnw spring-boot:run
   

The server will start on http://localhost:8080 (default port).

📂 Project Structure

• com.nextgencoder.elixirspin.controller: REST API endpoints (e.g., DeckController).
• com.nextgencoder.elixirspin.service: Core business logic and services.
• com.nextgencoder.elixirspin.domain: JPA entities and data models.
• com.nextgencoder.elixirspin.repository: Data access layer for PostgreSQL.
• com.nextgencoder.elixirspin.config: Configuration for Redis, Caffeine, and Resilience4j.
• com.nextgencoder.elixirspin.dto: Data Transfer Objects for API responses.

🛣 API Endpoints

The primary endpoint is managed by DeckController:

• GET /api/v1/deck/generate: Generates a randomized deck based on specified criteria.

---

Built with ❤️ for Clash Royale players.