# codescouts-academy/codescouts-spring-redis-rabbitmq-starter architecture

> Architecture diagram of the GitHub repository codescouts-academy/codescouts-spring-redis-rabbitmq-starter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter
- Repository: https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter

## Overview

##### Project type and purpose
- This is a Java Spring Boot microservice whose primary goal is to teach Redis (and RabbitMQ) integration.
- It exposes a simple REST API for storing and retrieving “Test” objects in Redis. Docker and Docker Compose orchestrate the service, Redis, and RabbitMQ.

##### File structure
- Top level:
- Dockerfile – builds the Spring Boot jar image
- docker-compose.yml – brings up Redis and RabbitMQ alongside the app
- Makefile – shortcuts for build, up, down
- pom.xml / .mvn / mvnw – Maven build
- src/main/java/com/codescouts/starter:
- RedisConfig.java – configures the Redis connection
- StarterApplication.java – Spring Boot entry point
- controllers/TestController.java – REST endpoints (/api/test)
- domain/Test.java – data model (id, value)
- services/RedisService.java – business logic for read/write to Redis
- src/main/resources/application.properties – host/port etc.
- src/test/java/... – unit tests for the application

##### Extract key insights from README
- Uses Docker Compose to launch Redis and RabbitMQ.
- Provides POST and GET endpoints to store and fetch Test objects in Redis.
- RabbitMQ is mentioned as a learning target (you may extend the service with message-based flows).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client
    Client["HTTP Client"]:::external

    %% Docker Compose Network
    subgraph "Docker Compose Network"
        style DockerComposeNetwork stroke-dasharray: 5 5
        direction TB

        subgraph "Spring Boot App"
            direction TB
            SA["StarterApplication"]:::entry
            RC["RedisConfig"]:::config
            TC["TestController"]:::controller
            RS["RedisService"]:::service
            D["Test (domain)"]:::domain
            Props["application.properties"]:::configfile
            POM["pom.xml"]:::maven
            MVW["mvnw & .mvn"]:::maven
            Make["Makefile"]:::infra
            DCFile["Dockerfile"]:::infra
        end

        Redis["Redis Data Store"]:::datastore
        MQ["RabbitMQ Broker"]:::broker
        DCCompose["docker-compose.yml"]:::infra
    end

    %% Relationships
    Client -->|"HTTP Request"| TC
    TC -->|"calls Service"| RS
    RS -->|"uses Config"| RC
    RC -->|"connects to"| Redis
    RS -->|"read/write Test"| Redis
    RS -->|"publish/consume"| MQ
    SA -->|"boots up"| TC
    SA -->|"boots up"| RS
    SA -->|"boots up"| RC
    Props -->|"loaded by"| SA
    DCCompose -->|"orchestrates"| SA
    DCCompose -->|"orchestrates"| Redis
    DCCompose -->|"orchestrates"| MQ
    Make -->|"runs"| DCCompose

    %% Click Events
    click SA "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/main/java/com/codescouts/starter/StarterApplication.java"
    click RC "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/main/java/com/codescouts/starter/RedisConfig.java"
    click TC "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/main/java/com/codescouts/starter/controllers/TestController.java"
    click D "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/main/java/com/codescouts/starter/domain/Test.java"
    click RS "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/main/java/com/codescouts/starter/services/RedisService.java"
    click Props "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/main/resources/application.properties"
    click DCFile "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/tree/main/Dockerfile"
    click DCCompose "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/docker-compose.yml"
    click POM "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/pom.xml"
    click MVW "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/.mvn"
    click Make "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/tree/main/Makefile"
    click StarterTests "https://github.com/codescouts-academy/codescouts-spring-redis-rabbitmq-starter/blob/main/src/test/java/com/codescouts/starter/StarterApplicationTests.java"

    %% Styles
    classDef external fill:#B0E0E6,stroke:#004C99,color:#000
    classDef entry fill:#D1E8FF,stroke:#005BB5,color:#000
    classDef controller fill:#CCE5FF,stroke:#1473E6,color:#000
    classDef service fill:#99CCFF,stroke:#005BB5,color:#000
    classDef config fill:#E6E6E6,stroke:#8C8C8C,color:#000
    classDef configfile fill:#F2F2F2,stroke:#B3B3B3,color:#000
    classDef domain fill:#E0FFE0,stroke:#33AA33,color:#000
    classDef datastore fill:#CCFFCC,stroke:#339933,color:#000
    classDef broker fill:#FFE5CC,stroke:#E67A00,color:#000
    classDef maven fill:#F0E6FF,stroke:#8C1AFF,color:#000
    classDef infra fill:#FFE6E6,stroke:#E60000,color:#000
```
