Skip to content

Commit 03e7f13

Browse files
committed
Update README: bump Spring Boot badge to 3.5.6 and normalize Markdown tables/whitespace
1 parent 0ff3b06 commit 03e7f13

3 files changed

Lines changed: 37 additions & 37 deletions

File tree

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
44
[![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.4.4-green)](https://spring.io/projects/spring-boot)
5+
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.5.6-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)
@@ -126,7 +126,7 @@ docker-compose up --build
126126
Then edit the copied file as needed.
127127

128128
4. **Run the application**
129-
129+
130130
Choose one of the following:
131131
- Using Gradle:
132132
```bash
@@ -202,24 +202,24 @@ The application provides REST API endpoints for user management and event operat
202202

203203
### User Management API
204204

205-
| Endpoint | Method | Description | Authentication |
206-
|----------|--------|-------------|---------------|
207-
| `/api/users` | GET | List all users | Admin |
208-
| `/api/users/{id}` | GET | Get user by ID | User/Admin |
209-
| `/api/users` | POST | Create new user | Public |
210-
| `/api/users/{id}` | PUT | Update user | User/Admin |
211-
| `/api/users/{id}` | DELETE | Delete user | User/Admin |
212-
| `/api/auth/login` | POST | User login | Public |
213-
| `/api/auth/logout` | POST | User logout | Authenticated |
205+
| Endpoint | Method | Description | Authentication |
206+
| ------------------ | ------ | --------------- | -------------- |
207+
| `/api/users` | GET | List all users | Admin |
208+
| `/api/users/{id}` | GET | Get user by ID | User/Admin |
209+
| `/api/users` | POST | Create new user | Public |
210+
| `/api/users/{id}` | PUT | Update user | User/Admin |
211+
| `/api/users/{id}` | DELETE | Delete user | User/Admin |
212+
| `/api/auth/login` | POST | User login | Public |
213+
| `/api/auth/logout` | POST | User logout | Authenticated |
214214

215215
### Event Management API
216216

217-
| Endpoint | Method | Description | Authentication |
218-
|----------|--------|-------------|---------------|
219-
| `/api/events` | GET | List events | Public |
220-
| `/api/events/{id}` | GET | Get event details | Public |
221-
| `/api/events` | POST | Create event | Admin |
222-
| `/api/events/{id}/register` | POST | Register for event | User |
217+
| Endpoint | Method | Description | Authentication |
218+
| --------------------------- | ------ | ------------------ | -------------- |
219+
| `/api/events` | GET | List events | Public |
220+
| `/api/events/{id}` | GET | Get event details | Public |
221+
| `/api/events` | POST | Create event | Admin |
222+
| `/api/events/{id}/register` | POST | Register for event | User |
223223

224224
### Response Format
225225

@@ -267,12 +267,12 @@ For detailed API documentation, start the application and visit `/swagger-ui.htm
267267
268268
The application supports multiple configuration profiles:
269269
270-
| Profile | Purpose | Database | Use Case |
271-
|---------|---------|----------|----------|
272-
| `local` | Local development | MariaDB/MySQL | Development with persistent database |
273-
| `test` | Testing | H2 (in-memory) | Automated testing |
274-
| `dev` | Development server | MariaDB/MySQL | Shared development environment |
275-
| `docker-keycloak` | Docker with Keycloak | MariaDB + Keycloak | OIDC authentication testing |
270+
| Profile | Purpose | Database | Use Case |
271+
| ----------------- | -------------------- | ------------------ | ------------------------------------ |
272+
| `local` | Local development | MariaDB/MySQL | Development with persistent database |
273+
| `test` | Testing | H2 (in-memory) | Automated testing |
274+
| `dev` | Development server | MariaDB/MySQL | Shared development environment |
275+
| `docker-keycloak` | Docker with Keycloak | MariaDB + Keycloak | OIDC authentication testing |
276276
277277
### Quick Configuration Setup
278278
@@ -380,7 +380,7 @@ export SPRING_SECURITY_FAILED_LOGIN_ATTEMPTS=5
380380
### Important Security Settings
381381
382382
- **BCrypt Strength**: Set to `12` or higher for production
383-
- **Session Timeout**: Default `30m`, adjust based on security requirements
383+
- **Session Timeout**: Default `30m`, adjust based on security requirements
384384
- **Account Lockout**: Configure failed login attempts and lockout duration
385385
- **CSRF Protection**: Enabled by default, ensure proper configuration for APIs
386386
@@ -506,7 +506,7 @@ docker-compose -f docker-compose-keycloak.yml up --build
506506
### Performance and Monitoring
507507
508508
- **Application Metrics**: `/actuator/metrics`
509-
- **Health Check**: `/actuator/health`
509+
- **Health Check**: `/actuator/health`
510510
- **Database Console**: `/h2-console` (when using H2)
511511
- **Log Levels**: Configure in `application.yml` or via `/actuator/loggers`
512512
@@ -568,16 +568,16 @@ This project supports **Spring Boot DevTools** for live reload and auto-restart.
568568
569569
### Technology Stack
570570
571-
| Layer | Technology | Purpose |
572-
|-------|------------|---------|
573-
| **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 |
576-
| **Data** | Spring Data JPA + Hibernate | Object-relational mapping and data access |
577-
| **Database** | MariaDB/MySQL | Primary data persistence |
578-
| **Testing** | JUnit 5 + Selenide | Unit, integration, and UI testing |
579-
| **Build** | Gradle | Dependency management and build automation |
580-
| **Containers** | Docker + Docker Compose | Development and deployment |
571+
| Layer | Technology | Purpose |
572+
| -------------- | --------------------------- | ---------------------------------------------- |
573+
| **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 |
576+
| **Data** | Spring Data JPA + Hibernate | Object-relational mapping and data access |
577+
| **Database** | MariaDB/MySQL | Primary data persistence |
578+
| **Testing** | JUnit 5 + Selenide | Unit, integration, and UI testing |
579+
| **Build** | Gradle | Dependency management and build automation |
580+
| **Containers** | Docker + Docker Compose | Development and deployment |
581581
582582
---
583583

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ repositories {
4040
dependencies {
4141
// DigitalSanctuary Spring User Framework
4242
implementation 'com.digitalsanctuary:ds-spring-user-framework:3.5.1'
43-
43+
l
4444
// Spring Boot starters
4545
implementation 'org.springframework.boot:spring-boot-starter-actuator'
4646
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

src/main/resources/application.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ user:
117117
bcryptStrength: 12 # The bcrypt strength to use for password hashing. The higher the number, the longer it takes to hash the password. The default is 12. The minimum is 4. The maximum is 31.
118118
testHashTime: true # If true, the test hash time will be logged to the console on startup. This is useful for determining the optimal bcryptStrength value.
119119
defaultAction: deny # The default action for all requests. This can be either deny or allow.
120-
unprotectedURIs: /,/index.html,/favicon.ico,/apple-touch-icon-precomposed.png,/css/*,/js/*,/js/user/*,/js/event/*,/img/**,/user/registration,/user/resendRegistrationToken,/user/resetPassword,/user/registrationConfirm,/user/changePassword,/user/savePassword,/oauth2/authorization/*,/login,/user/login,/user/login.html,/swagger-ui.html,/swagger-ui/**,/v3/api-docs/**,/event/,/event/list.html,/event/**,/about.html,error.html # A comma delimited list of URIs that should not be protected by Spring Security if the defaultAction is deny.
120+
unprotectedURIs: /,/index.html,/favicon.ico,/apple-touch-icon-precomposed.png,/css/*,/js/*,/js/user/*,/js/event/*,/img/**,/user/registration,/user/resendRegistrationToken,/user/resetPassword,/user/registrationConfirm,/user/changePassword,/user/savePassword,/oauth2/authorization/*,/login,/user/login,/user/login.html,/swagger-ui.html,/swagger-ui/**,/v3/api-docs/**,/event/,/event/list.html,/event/**,/about.html,error.htmla # A comma delimited list of URIs that should not be protected by Spring Security if the defaultAction is deny.
121121
protectedURIs: /protected.html # A comma delimited list of URIs that should be protected by Spring Security if the defaultAction is allow.
122122
disableCSRFdURIs: /no-csrf-test # A comma delimited list of URIs that should not be protected by CSRF protection. This may include API endpoints that need to be called without a CSRF token.
123123

0 commit comments

Comments
 (0)