Prerequisites
Before you begin, ensure you have the following installed:- Java 17 or higher
- Gradle 8.5 (included via Gradle wrapper)
- Git for cloning the repository
Getting Started
Verify Java Installation
Confirm that Java 17 is installed and set as your default:You should see output indicating Java 17 or higher.
Build the Project
Use the Gradle wrapper to build the project and download dependencies:This command will:
- Download all project dependencies
- Compile the source code
- Run all tests
- Generate the executable JAR file
Run the Application
Start the application using one of these methods:The application will start on
http://localhost:8080.Configuration
The application uses an embedded H2 database by default, configured insrc/main/resources/application.yaml. No additional database setup is required for local development.
Default Configuration
- Server Port: 8080
- Database: H2 (in-memory)
- CORS: Enabled for all origins (development only)
- Security: Permissive configuration (development only)
Troubleshooting
Port Already in Use
If port 8080 is already in use, you can change it by setting theSERVER_PORT environment variable:
Dependency Issues
If you encounter dependency resolution problems, try refreshing dependencies:IDE Integration
VS Code:- Open Command Palette (
Ctrl+Shift+P) - Run
Java: Restart Language Server - If issues persist, run
Java: Clean the Java Language Server Workspace
- Open the Gradle tool window
- Click the Refresh button (⟳)
- If issues persist, go to
File → Invalidate Caches / Restart...
Next Steps
- Learn how to run the application with Docker
- Explore the Testing Guide to understand the test structure
- Check out the API Reference for complete endpoint documentation