Getting Started¶
This guide provides everything needed to bootstrap, configure, build, and run the CIS platform locally.
Prerequisites¶
Before starting, verify the following tools are installed on your host workstation:
| Prerequisite | Recommended Version | Verification Command |
|---|---|---|
| JDK (Java) | Java 25 (OpenJDK / Eclipse Temurin) | java -version |
| Docker Engine | Docker Desktop 24+ / Docker CE with Compose v2 | docker compose version |
| Git | 2.40+ | git --version |
| Python | 3.10+ (for local sandboxed docs) | python --version |
[!NOTE] Gradle is managed directly by the repository wrapper (
./gradlewor.\gradlew.bat). You do not need a separate global Gradle installation.
Onboarding Pathway¶
- Local Setup: Configure environment files (
.env.dev), start supporting containers (Oracle, Redis, LDAP, Mailpit), and understand port assignments. - Build & Test: Compile services, run offline Gradle builds, execute Testcontainers integration tests, and inspect JaCoCo coverage reports.
- IDE Setup: Configure IntelliJ IDEA or VS Code for Lombok, MapStruct annotation processing, and profile management.