Skip to content

Commit c806854

Browse files
committed
Update README and LoginHelperServiceTest for clarity and version bump
1 parent 1ad9735 commit c806854

2 files changed

Lines changed: 83 additions & 109 deletions

File tree

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Check out the [Spring User Framework Demo Application](https://github.com/devond
1818
- [Maven](#maven)
1919
- [Gradle](#gradle)
2020
- [Quick Start](#quick-start)
21+
- [Prerequisites](#prerequisites)
22+
- [Step 1: Add Dependencies](#step-1-add-dependencies)
23+
- [Step 2: Database Configuration](#step-2-database-configuration)
24+
- [Step 3: JPA Configuration](#step-3-jpa-configuration)
25+
- [Step 4: Email Configuration (Optional but Recommended)](#step-4-email-configuration-optional-but-recommended)
26+
- [Step 5: Essential Framework Configuration](#step-5-essential-framework-configuration)
27+
- [Step 6: Create User Profile Extension (Optional)](#step-6-create-user-profile-extension-optional)
28+
- [Step 7: Start Your Application](#step-7-start-your-application)
29+
- [Step 8: Test Core Features](#step-8-test-core-features)
30+
- [Step 9: Customize Pages (Optional)](#step-9-customize-pages-optional)
31+
- [Complete Example Configuration](#complete-example-configuration)
32+
- [Next Steps](#next-steps)
2133
- [Configuration](#configuration)
2234
- [Security Features](#security-features)
2335
- [Role-Based Access Control](#role-based-access-control)
@@ -84,14 +96,14 @@ Check out the [Spring User Framework Demo Application](https://github.com/devond
8496
<dependency>
8597
<groupId>com.digitalsanctuary</groupId>
8698
<artifactId>ds-spring-user-framework</artifactId>
87-
<version>3.3.0</version>
99+
<version>3.4.0</version>
88100
</dependency>
89101
```
90102

91103
### Gradle
92104

93105
```groovy
94-
implementation 'com.digitalsanctuary:ds-spring-user-framework:3.3.0'
106+
implementation 'com.digitalsanctuary:ds-spring-user-framework:3.4.0'
95107
```
96108

97109
## Quick Start
@@ -237,7 +249,7 @@ user:
237249
bcryptStrength: 12 # Password hashing strength
238250
failedLoginAttempts: 5 # Account lockout threshold
239251
accountLockoutDuration: 15 # Lockout duration in minutes
240-
252+
241253
# Registration settings
242254
registration:
243255
sendVerificationEmail: false # true = email verification required
@@ -250,16 +262,16 @@ If you need additional user data beyond the built-in fields, create a profile ex
250262

251263
```java
252264
@Entity
253-
@Table(name = "app_user_profile")
265+
@Table(name = "app_user_profile")
254266
public class AppUserProfile extends BaseUserProfile {
255267
private String department;
256268
private String phoneNumber;
257269
private LocalDate birthDate;
258-
270+
259271
// Getters and setters
260272
public String getDepartment() { return department; }
261273
public void setDepartment(String department) { this.department = department; }
262-
274+
263275
// ... other getters and setters
264276
}
265277
```
@@ -313,12 +325,12 @@ spring:
313325
username: appuser
314326
password: apppass
315327
driver-class-name: org.mariadb.jdbc.Driver
316-
328+
317329
jpa:
318330
hibernate:
319331
ddl-auto: update
320332
show-sql: false
321-
333+
322334
mail:
323335
host: smtp.gmail.com
324336
port: 587
@@ -334,16 +346,16 @@ spring:
334346
user:
335347
mail:
336348
fromAddress: noreply@myapp.com
337-
349+
338350
security:
339351
defaultAction: deny
340352
bcryptStrength: 12
341353
failedLoginAttempts: 3
342354
accountLockoutDuration: 30
343-
355+
344356
registration:
345357
sendVerificationEmail: true
346-
358+
347359
# Optional: Audit logging
348360
audit:
349361
logEvents: true
@@ -420,7 +432,7 @@ The registration flow is configurable and can operate in two modes:
420432
421433
**Auto-Enable Mode** (default: `user.registration.sendVerificationEmail=false`):
422434
- Form submission validation
423-
- Email uniqueness check
435+
- Email uniqueness check
424436
- User account is immediately enabled and can login
425437
- No verification email is sent
426438
- User has full access immediately after registration

0 commit comments

Comments
 (0)