Skip to content

Commit 0a61451

Browse files
devondragonclaude
andcommitted
Update README for Spring Boot 4.0 and add version compatibility
- Update badges: Java 21+, Spring Boot 4.0 - Add Version Compatibility section with table - Document v1.0.0-springboot3 tag for Spring Boot 3.x users - Update prerequisites to require Java 21 - Update Technology Stack table (Spring Boot 4.0+, Spring Security 7) - Update troubleshooting to reference Java 21 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 07766de commit 0a61451

1 file changed

Lines changed: 31 additions & 6 deletions

File tree

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Spring User Framework Demo Application
22

33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4-
[![Java Version](https://img.shields.io/badge/Java-17%2B-brightgreen)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
5-
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.5.6-green)](https://spring.io/projects/spring-boot)
4+
[![Java Version](https://img.shields.io/badge/Java-21%2B-brightgreen)](https://www.oracle.com/java/technologies/downloads/)
5+
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-4.0-green)](https://spring.io/projects/spring-boot)
66
[![Gradle](https://img.shields.io/badge/Gradle-8.0%2B-blue)](https://gradle.org/)
77
[![Docker](https://img.shields.io/badge/Docker-Supported-blue)](https://www.docker.com/)
88
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](contributing)
@@ -14,6 +14,7 @@ A comprehensive demonstration application for the [Spring User Framework](https:
1414

1515
## Table of Contents
1616
- [Overview](#overview)
17+
- [Version Compatibility](#version-compatibility)
1718
- [Features](#features)
1819
- [Prerequisites](#prerequisites)
1920
- [Quick Start](#quick-start)
@@ -35,6 +36,30 @@ This demo application serves as a reference implementation of the [Spring User F
3536

3637
The application implements an event management system where users can browse, register for, and manage events. This demonstrates how to build application-specific functionality on top of the user management framework.
3738

39+
## Version Compatibility
40+
41+
This demo application tracks the latest version of the Spring User Framework:
42+
43+
| Demo App Version | Spring Boot | Spring User Framework | Java | Branch/Tag |
44+
|------------------|-------------|----------------------|------|------------|
45+
| main (current) | 4.0.x | 4.0.x | 21+ | `main` |
46+
| 1.0.0-springboot3 | 3.5.x | 3.5.x | 17+ | [`v1.0.0-springboot3`](https://github.com/devondragon/SpringUserFrameworkDemoApp/tree/v1.0.0-springboot3) |
47+
48+
### Using Spring Boot 3.x?
49+
50+
If you need to use Spring Boot 3.5.x with Java 17, use the tagged version:
51+
52+
```bash
53+
git clone https://github.com/devondragon/SpringUserFrameworkDemoApp.git
54+
cd SpringUserFrameworkDemoApp
55+
git checkout v1.0.0-springboot3
56+
```
57+
58+
This version uses:
59+
- Spring Boot 3.5.6
60+
- Spring User Framework 3.5.1
61+
- Java 17+
62+
3863
## Features
3964

4065
- **User Management**
@@ -68,7 +93,7 @@ The application implements an event management system where users can browse, re
6893

6994
Before you begin, ensure you have the following installed:
7095

71-
- **Java**: JDK 17 or higher ([Download](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html))
96+
- **Java**: JDK 21 or higher ([Download](https://www.oracle.com/java/technologies/downloads/)) - *Note: For Spring Boot 3.x version, Java 17+ is sufficient*
7297
- **Database**: MariaDB, MySQL, or Docker for containerized database
7398
- **Build Tool**: Gradle (included via wrapper) or Maven
7499
- **Optional**: Docker and Docker Compose for containerized setup
@@ -571,8 +596,8 @@ This project supports **Spring Boot DevTools** for live reload and auto-restart.
571596
| Layer | Technology | Purpose |
572597
| -------------- | --------------------------- | ---------------------------------------------- |
573598
| **Frontend** | Thymeleaf + Bootstrap | Server-side rendering with responsive UI |
574-
| **Backend** | Spring Boot 3.4+ | Application framework and dependency injection |
575-
| **Security** | Spring Security | Authentication, authorization, CSRF protection |
599+
| **Backend** | Spring Boot 4.0+ | Application framework and dependency injection |
600+
| **Security** | Spring Security 7 | Authentication, authorization, CSRF protection |
576601
| **Data** | Spring Data JPA + Hibernate | Object-relational mapping and data access |
577602
| **Database** | MariaDB/MySQL | Primary data persistence |
578603
| **Testing** | JUnit 5 + Selenide | Unit, integration, and UI testing |
@@ -601,7 +626,7 @@ Solution:
601626
Solution:
602627
1. ./gradlew clean build --refresh-dependencies
603628
2. Check internet connection
604-
3. Verify Java version: java -version (requires JDK 17+)
629+
3. Verify Java version: java -version (requires JDK 21+)
605630
4. Clear Gradle cache: rm -rf ~/.gradle/caches
606631
```
607632

0 commit comments

Comments
 (0)