Welcome to the java-spring-tutorials documentation.
| Document | Description |
|---|---|
| AGENTS.md | AI guidance for scaffolding and consistency |
| QUICK_START.md | Run instructions for all modules |
| CI_PLAN.md | CI/CD quality gates and thresholds |
| INDEX.md | Complete file index |
Repository-level ADRs are in adr/:
| ADR | Decision |
|---|---|
| ADR-0001 | Shields.io endpoint badges |
| ADR-0002 | CI quality gates stack |
See adr/README.md for the full index including module-specific ADRs.
Each module has its own documentation in modules/{module}/docs/:
| Module | README | Concepts |
|---|---|---|
| 01-spring-hello-rest | README | REST controllers, records |
| 02-spring-scheduling-tasks | README | @Scheduled, Awaitility testing |
| 03-quote-service | README | Quote API, ThreadLocalRandom |
| 03-spring-consuming-rest | README | RestClient, error handling |
| 04-spring-relational-data-access | README | JdbcTemplate, H2, CommandLineRunner |
Scaffolding templates for new modules and docs:
| Template | Purpose |
|---|---|
| MODULE_README.md | New module README |
| pom.xml | Child module POM with quality plugins |
| spring-initializr.md | Spring Initializr setup docs |
| run-instructions.md | Module run instructions |
| ADR_TEMPLATE.md | Architecture Decision Record |
| CONCEPT.md | Technical explanation |
| DEVELOPER_NOTES.md | Personal notes |