achalbi/chameleon

Project Chameleon has been designed as an educational example project for learning the basics of the Spring Boot ecosystem. But project Chameleon tries to be more than just a simple "hello world". It has all the needed parts in place to be as close to a "real world" production-ready software as possible.

Project Chameleon

Project Chameleon has been designed as an educational example project for learning the basics of the Spring Boot ecosystem. But project Chameleon tries to be more than just a simple "hello world". It has all the needed parts in place to be as close to a "real world" production-ready software as possible.

Prerequisites

General

• Java 17+

• Docker 19+

Windows

• Recommended: Windows Subsystem for Linux 2+

Features

Project Chameleon currently contains the following features:

Table 1. Features of project Chameleon

1 Architecture	2 REST API	3 Database	4 Security	5 Logging	6 Testing
1.1 Use cases 1.2 Architecture with reverse proxy 1.3 Local deployment 1.4 Build with Gradle 1.5 Ports and adapters 1.6 Code structure 1.7 Configuration	2.1 REST controller with GET, POST, DELETE, and PATCH 2.2 OpenAPI with Swagger UI (URL: http://localhost:4444/swagger-ui.html) 2.3 Dtos and bean validation 2.4 Model mapper 2.5 Error handling 2.6 Etags	3.1 Storage in a relational database with PostgreSQL with optimistic concurrency control 3.2 JPA and Spring Data 3.3 Database migration with Flyway	4.1 Single-sign on (SSO) with Keycloak (URL: http://localhost:4444/auth) 4.2 Role-base access control (RBAC, JSR 250) 4.3 OWASP dependency check (report: build/reports/owasp)	5.1 JSON logging 5.2 Structured logging 5.3 Request ids 5.4 Users and roles	6.1 Unit tests with JUnit 5 (report: build/reports/tests) with assertions with Google Truth with coverage report using JaCoCo (report: build/reports/jacoco) 6.2 Architectural unit tests with ArchUnit 6.3 Integration tests with Cucumber (report: build/reports/cucumber)

Copyright (c) 2023 Christoph Ehlers, ConSol Software GmbH