User Guide
Operate the BFF locally and navigate the generated docs.
This guide covers local startup, JWT usage, API exploration, generated documentation, and troubleshooting for the Spring Boot WebFlux Backend for Frontend.
Purpose
The README is the concise GitHub entry point. This User Guide is the operational reference for engineers who want to run the application, call the API, inspect the generated contract, and understand the local development workflow.
The guide is maintained as direct HTML source under .github/pages/user-guide/.
CI assembles it into target/pages/user-guide/ with the rest of the Pages artifact.
This avoids a Markdown conversion pipeline while keeping the published guide accessible and controlled.
Prerequisites
Java 21, the Maven Wrapper from this repository, Docker, and Docker Compose.
IntelliJ IDEA is useful for local debugging, but it is not required for the Maven or Docker workflows.
Guide Map
Run from IntelliJ, start Docker Compose, generate a local JWT, and call /api/dashboard.
Use Swagger UI, download OpenAPI JSON/YAML, understand JWT rules, and review fallback behavior.
Run tests, inspect coverage, generate Javadoc, understand the Pages artifact, and resolve common issues.
Open the CI-published Swagger UI backed by the generated OpenAPI JSON contract.