IDE Instructions

Jump to bottom Edit New page

Subhrodip Mohanta edited this page Apr 3, 2026 · 1 revision

IDE Instructions

While you can use any editor to develop this project, we recommend IntelliJ IDEA for the best experience with Spring Boot 4.0 and Java 21.

Recommended IDE: IntelliJ IDEA

1. Project Setup

Open IntelliJ and select File > Open.
Select the pom.xml in the root of the repository.
When prompted, select Open as Project.

2. Required Plugins

Ensure the following plugins are installed and enabled:

Lombok: Essential for our data models.
Google Java Format: To maintain our strict formatting standards.

3. Formatting Configuration

We use Google Java Format via the Spotless plugin.

Do not manually configure IDE indentations.
Use the following command to format your code before every commit:
```
./mvnw spotless:apply
```
(Optional) Enable "Actions on Save" in IntelliJ to run mvn spotless:apply automatically.

4. Compiler Settings

Go to Settings > Build, Execution, Deployment > Compiler > Annotation Processors.
Check Enable annotation processing.
Ensure the project SDK is set to Java 21.

Alternative: Visual Studio Code

If using VS Code, install the following extensions:

Extension Pack for Java (Microsoft)
Spring Boot Extension Pack (VMware)
Lombok Annotations support (GabrielBB)