# SpringForge Public Discovery Index & Sitemap

Version: 1
Base URL: https://springforge.xyz

SpringForge exposes public documentation, architectural templates, interactive code generation, and developer guides. This document serves as a comprehensive discovery index for search crawlers, LLM agents, and developers.

## Discovery surfaces

- [`/llms.txt`](https://springforge.xyz/llms.txt) — High-level LLM and operator context surface
- [`/sitemap.xml`](https://springforge.xyz/sitemap.xml) — Standard XML sitemap for search engine crawlers
- [`/sitemap.md`](https://springforge.xyz/sitemap.md) — Comprehensive Markdown discovery index

## Core Pages & Markdown Twins

- [/](https://springforge.xyz/) (HTML) | [docs.md](https://springforge.xyz/docs.md) (Markdown twin)
- [/docs](https://springforge.xyz/docs) (HTML) | [docs.md](https://springforge.xyz/docs.md) (Markdown twin)
- [/quickstart](https://springforge.xyz/quickstart) (HTML) | [quickstart.md](https://springforge.xyz/quickstart.md) (Markdown twin)
- [/guides](https://springforge.xyz/guides) (HTML) | [guides.md](https://springforge.xyz/guides.md) (Markdown twin)
- [/generator](https://springforge.xyz/generator) (HTML) | [generator.md](https://springforge.xyz/generator.md) (Markdown twin)
- [/pricing](https://springforge.xyz/pricing) (HTML) | [pricing.md](https://springforge.xyz/pricing.md) (Markdown twin)
- [/blog](https://springforge.xyz/blog) (HTML) | [blog.md](https://springforge.xyz/blog.md) (Markdown twin)
- [/about](https://springforge.xyz/about) (HTML) | [about.md](https://springforge.xyz/about.md) (Markdown twin)
- [/feedback](https://springforge.xyz/feedback) (HTML) | [feedback.md](https://springforge.xyz/feedback.md) (Markdown twin)
- [/legal](https://springforge.xyz/legal) (HTML) | [legal.md](https://springforge.xyz/legal.md) (Markdown twin)
- [/privacy-policy](https://springforge.xyz/privacy-policy) (HTML) | [privacy-policy.md](https://springforge.xyz/privacy-policy.md) (Markdown twin)
- [/terms-and-conditions](https://springforge.xyz/terms-and-conditions) (HTML) | [terms-and-conditions.md](https://springforge.xyz/terms-and-conditions.md) (Markdown twin)

## Curated Spring Boot Architecture Blueprints (20 Production Blueprints)

SpringForge provisions 20 curated production-ready architecture blueprints. Each blueprint automatically configures Spring Boot 3.4 / Java 21 starters, domain entities, MapStruct DTOs, JPA repositories, database migrations, and Docker Compose environments:

### 1. [REST API](https://springforge.xyz/docs#template-rest-api)
- **Category**: Web & APIs | **Architecture Pattern**: Layered Architecture
- **Dependencies**: `spring-boot-starter-web, validation, springdoc-openapi, data-jpa, h2`
- **Default Entities**: User (id, username, email, active, createdAt)
- **Generated Scaffolding**: Layered controller-service-repository hierarchy, DTO validation, OpenAPI 3 Swagger UI, in-memory H2 database.
- **Primary Use Case**: Clean-architecture REST microservices, CRUD endpoints, and SPA decoupled backends.

### 2. [CRUD with PostgreSQL & JPA](https://springforge.xyz/docs#template-crud-postgresql)
- **Category**: Data & Persistence | **Architecture Pattern**: Relational JPA Persistence
- **Dependencies**: `spring-boot-starter-web, data-jpa, postgresql, flyway / liquibase, validation`
- **Default Entities**: Customer (UUID, firstName, lastName, email, phone), Address (street, city, state, zipCode, country)
- **Generated Scaffolding**: Spring Data JPA repositories, MapStruct DTO mappers, Flyway/Liquibase versioned migrations, HikariCP connection pool, Testcontainers integration tests, Docker Compose.
- **Primary Use Case**: Production relational backends requiring automated schema migrations and ACID transactions.

### 3. [Secured JWT API](https://springforge.xyz/docs#template-secured-jwt-api)
- **Category**: Security & Auth | **Architecture Pattern**: Stateless Token Security
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-security, data-jpa, postgresql, jjwt`
- **Default Entities**: User (username, email, passwordHash, roles), RefreshToken (token, expiryDate, revoked)
- **Generated Scaffolding**: Spring Security 6 filter chain, JwtAuthenticationFilter, JwtTokenProvider (HMAC SHA-256), BCrypt hashing, /api/auth/login and /api/auth/register endpoints.
- **Primary Use Case**: User registration, login, token refresh, and Role-Based Access Control (RBAC) protected APIs.

### 4. [Redis Cache & API](https://springforge.xyz/docs#template-redis-api)
- **Category**: Data & Performance | **Architecture Pattern**: Distributed In-Memory Caching
- **Dependencies**: `spring-boot-starter-web, data-redis, data-jpa, postgresql`
- **Default Entities**: Product (sku, name, price, stockQuantity)
- **Generated Scaffolding**: Lettuce connection pool, RedisTemplate<String, Object>, @Cacheable and @CacheEvict annotations, custom TTL cache manager, Docker Compose Redis container.
- **Primary Use Case**: Read-heavy applications demanding sub-millisecond query responses and distributed cache invalidation.

### 5. [Spring Cloud API Gateway](https://springforge.xyz/docs#template-api-gateway)
- **Category**: Microservices & Routing | **Architecture Pattern**: Edge Reverse Proxy & Routing
- **Dependencies**: `spring-cloud-starter-gateway, spring-boot-starter-actuator`
- **Default Entities**: None (pure routing infrastructure)
- **Generated Scaffolding**: Netty-based reactive gateway, dynamic path rewriting, CORS filtering, Redis token bucket rate limiting, Resilience4j circuit breakers.
- **Primary Use Case**: Unified entry point for microservice fleets, request throttling, SSL termination, and edge security.

### 6. [Kafka Event Service](https://springforge.xyz/docs#template-kafka-event-service)
- **Category**: Messaging & Events | **Architecture Pattern**: Event-Driven Architecture
- **Dependencies**: `spring-boot-starter-web, spring-kafka, spring-boot-starter-actuator`
- **Default Entities**: EventRecord (topic, partition, offset, payload, timestamp)
- **Generated Scaffolding**: KafkaTemplate producer, @KafkaListener consumer bindings, JSON serializers/deserializers, Dead-Letter Topic (DLT) retry handler, Docker Compose Kafka/KRaft.
- **Primary Use Case**: High-throughput asynchronous stream processing, telemetry streaming, and decoupled event broadcasting.

### 7. [RabbitMQ Messaging](https://springforge.xyz/docs#template-rabbitmq-messaging)
- **Category**: Messaging & Events | **Architecture Pattern**: Enterprise AMQP Message Broker
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-amqp, validation`
- **Default Entities**: QueueMessage (exchange, routingKey, payload, status, retryCount)
- **Generated Scaffolding**: RabbitTemplate, direct/topic/fanout exchange definitions, @RabbitListener worker pools, Dead-Letter Exchange (DLX) error queues, Docker Compose RabbitMQ Management.
- **Primary Use Case**: Transactional messaging, guaranteed at-least-once delivery, and background worker queues.

### 8. [GraphQL Subgraph API](https://springforge.xyz/docs#template-graphql-api)
- **Category**: Web & APIs | **Architecture Pattern**: Schema-First GraphQL Federation
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-graphql, data-jpa, postgresql`
- **Default Entities**: Author (name, bio), Book (title, isbn, pageCount, author)
- **Generated Scaffolding**: Schema-first SDL (schema.graphqls), @QueryMapping, @MutationMapping, DataLoader batching (preventing N+1 queries), GraphiQL interactive playground.
- **Primary Use Case**: Flexible frontend querying, Backend-for-Frontend (BFF), mobile client payload optimization.

### 9. [Reactive WebFlux & R2DBC](https://springforge.xyz/docs#template-reactive-webflux)
- **Category**: Web & Reactive | **Architecture Pattern**: Asynchronous Non-Blocking
- **Dependencies**: `spring-boot-starter-webflux, spring-boot-starter-data-r2dbc, r2dbc-postgresql`
- **Default Entities**: User (id, username, email, active)
- **Generated Scaffolding**: Project Reactor non-blocking controllers (Mono/Flux), reactive R2DBC database repository, backpressure streaming, Netty runtime.
- **Primary Use Case**: High-concurrency streaming APIs, Server-Sent Events (SSE), IoT telemetry data ingestion.

### 10. [WebSocket & STOMP Messaging](https://springforge.xyz/docs#template-websocket-messaging)
- **Category**: Real-Time & Messaging | **Architecture Pattern**: Bidirectional STOMP Broker
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-websocket, spring-boot-starter-security`
- **Default Entities**: WebSocketPayload (destination, sender, payload, timestamp)
- **Generated Scaffolding**: @EnableWebSocketMessageBroker, SockJS fallback, /app incoming prefixes, /topic and /queue outgoing brokers, JWT channel security interceptors.
- **Primary Use Case**: Live status dashboards, financial market price feeds, collaborative real-time editors.

### 11. [Real-Time Chat Application](https://springforge.xyz/docs#template-real-time-chat)
- **Category**: Real-Time & Messaging | **Architecture Pattern**: Clustered WebSocket with Redis Pub/Sub
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-websocket, data-redis, data-jpa, postgresql`
- **Default Entities**: ChatMessage (senderId, recipientId, roomId, content, status, sentAt)
- **Generated Scaffolding**: 1-to-1 direct messaging, chat room broadcast channels, online user presence tracking via Redis keys, message persistence in PostgreSQL.
- **Primary Use Case**: Customer support widgets, collaborative team chat platforms, in-game messaging.

### 12. [Event-Driven Architecture & CQRS](https://springforge.xyz/docs#template-event-driven-architecture)
- **Category**: Distributed Architecture | **Architecture Pattern**: CQRS & Transactional Outbox
- **Dependencies**: `spring-boot-starter-web, spring-kafka, data-jpa, postgresql, flyway`
- **Default Entities**: OrderCommandEntity (write model), OutboxEvent (aggregateType, aggregateId, eventType, payload, published)
- **Generated Scaffolding**: Command and Query segregation, Transactional Outbox pattern with atomic database writes, Kafka event streaming, idempotent consumers.
- **Primary Use Case**: Financial transaction ledgers, distributed sagas, audit event trails without two-phase commit.

### 13. [Microservices Ready Stack](https://springforge.xyz/docs#template-microservices-ready)
- **Category**: Microservices & Cloud | **Architecture Pattern**: Cloud-Native Microservices
- **Dependencies**: `spring-boot-starter-web, spring-cloud-starter-netflix-eureka-client, loadbalancer, actuator, prometheus`
- **Default Entities**: ServiceMetadata (serviceId, environment, version, lastHeartbeat)
- **Generated Scaffolding**: Eureka service discovery, Spring Cloud LoadBalancer client-side routing, Micrometer distributed tracing context, Kubernetes-ready health checks.
- **Primary Use Case**: Spring Cloud microservice fleets, Kubernetes container pods, resilient distributed systems.

### 14. [Modular Monolith Architecture](https://springforge.xyz/docs#step-2-templates)
- **Category**: Architecture Strategy | **Architecture Pattern**: Bounded-Context Domain Package Isolation
- **Dependencies**: `spring-boot-starter-web, data-jpa, postgresql, flyway, actuator`
- **Default Entities**: Domain-specific module entities (Catalog, Orders, Billing)
- **Generated Scaffolding**: Bounded-context domain packages, asynchronous in-memory Spring domain events, isolated repositories, unified deployment artifact.
- **Primary Use Case**: Clean architectural boundaries and domain-driven design (DDD) without distributed microservices network overhead.

### 15. [E-Commerce Ecosystem](https://springforge.xyz/docs#template-ecommerce-platform)
- **Category**: Distributed Commerce | **Architecture Pattern**: Microservices Saga & Distributed Locks
- **Dependencies**: `spring-boot-starter-web, data-jpa, data-redis, spring-kafka, postgresql, redisson`
- **Default Entities**: Product (sku, price, inventoryCount), Order, OrderItem, PaymentRecord
- **Generated Scaffolding**: Redis shopping cart, Redisson distributed inventory locks preventing flash-sale overselling, Kafka saga orchestration across order and payment services.
- **Primary Use Case**: Production retail platforms, digital checkouts, high-concurrency ticket/inventory reservations.

### 16. [Spring Batch Processing & ETL](https://springforge.xyz/docs#template-batch-processing)
- **Category**: Data Processing & Pipelines | **Architecture Pattern**: Chunk-Oriented ETL
- **Dependencies**: `spring-boot-starter-batch, data-jpa, postgresql, actuator`
- **Default Entities**: ProcessedRecord (jobExecutionId, recordKey, payload, status, processedAt)
- **Generated Scaffolding**: Chunk-oriented processing steps (ItemReader, ItemProcessor, ItemWriter), skip and retry policies, batch execution metadata tables, @Scheduled cron triggers.
- **Primary Use Case**: Nightly banking reconciliation, bulk CSV/XML importing, database data warehousing.

### 17. [PostgreSQL Change Data Capture (CDC)](https://springforge.xyz/docs#template-postgresql-cdc)
- **Category**: Data Streaming | **Architecture Pattern**: Database WAL Log Streaming via Debezium
- **Dependencies**: `spring-boot-starter-web, data-jpa, postgresql, spring-kafka, debezium-core`
- **Default Entities**: ChangeEvent (tableName, operation, beforePayload, afterPayload, capturedAt)
- **Generated Scaffolding**: PostgreSQL logical decoding (pgoutput), Debezium Kafka Connect connector, streaming database WAL changes, real-time consumer handlers.
- **Primary Use Case**: Zero-overhead database replication, real-time search engine sync (Postgres to Elasticsearch), cache eviction.

### 18. [Prometheus & Grafana Observability](https://springforge.xyz/docs#template-observability-stack)
- **Category**: Observability & DevOps | **Architecture Pattern**: Metrics & Production Telemetry
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-actuator, micrometer-registry-prometheus`
- **Default Entities**: MetricSample (metricName, value, tags, recordedAt)
- **Generated Scaffolding**: /actuator/prometheus scrape endpoint, JVM/HikariCP metrics, pre-configured prometheus.yml, provisioned Grafana dashboards, Docker Compose.
- **Primary Use Case**: Production SLA monitoring, capacity planning, application performance alerting.

### 19. [Mobile Application Backend](https://springforge.xyz/docs#template-mobile-backend)
- **Category**: Web & Mobile | **Architecture Pattern**: Mobile API & Push Delivery
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-security, data-jpa, postgresql, validation`
- **Default Entities**: MobileUser (email, phone), DeviceToken (userId, platform, token, appVersion, lastSeen)
- **Generated Scaffolding**: Mobile JWT authentication with token refresh, FCM/APNs device registration, delta sync timestamps, bandwidth-optimized payloads.
- **Primary Use Case**: iOS and Android companion APIs, offline-first mobile sync architectures, push notification delivery.

### 20. [Admin Dashboard Backend](https://springforge.xyz/docs#template-admin-dashboard-backend)
- **Category**: Governance & Security | **Architecture Pattern**: Role-Based Access Control & Audit Logging
- **Dependencies**: `spring-boot-starter-web, spring-boot-starter-security, data-jpa, postgresql, actuator`
- **Default Entities**: User, Role, Permission, AuditLog (actorId, action, targetResource, clientIp, timestamp), SystemSetting
- **Generated Scaffolding**: RBAC with @PreAuthorize, automatic JPA auditing (@CreatedBy, @CreatedDate), immutable audit log table, system configuration APIs.
- **Primary Use Case**: Enterprise internal administrative tools, CMS platforms, regulatory-audited back-office systems.