Skip to content

Commit 0a1c435

Browse files
FINERACT-792: Improve developer environment setup and IntelliJ IDEA guidance
1 parent 4bfae04 commit 0a1c435

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,15 @@ This is useful for repeated test runs (say, for timing) when gradle would otherw
9595

9696
See the next section for testing in Eclipse and [here](https://fineract-academy.com) for testing in IntelliJ.
9797

98+
## Recommended IDEs
99+
100+
Apache Fineract can be developed using multiple IDEs. The most commonly used and supported IDEs are:
101+
102+
- **Eclipse IDE** – Fully supported and commonly used within the community.
103+
- **IntelliJ IDEA (Community or Ultimate)** – Recommended for most developers due to excellent Gradle support and debugging experience.
104+
105+
The sections below provide setup guidance for each IDE.
106+
98107
### How to run and debug in Eclipse IDE
99108

100109
It is possible to run Fineract in Eclipse IDE and also to debug Fineract using Eclipse's debugging facilities.
@@ -111,6 +120,29 @@ You can also use Eclipse JUnit support to run tests in Eclipse (Run As->JUnit Te
111120

112121
Finally, modifying source code in Eclipse automatically triggers hot code replace to a running instance, allowing you to immediately test your changes
113122

123+
## How to run and debug in IntelliJ IDEA
124+
125+
IntelliJ IDEA provides strong Gradle integration and is recommended for most new contributors.
126+
127+
### Prerequisites
128+
- IntelliJ IDEA (Community Edition is sufficient)
129+
- Java 17 (as required by Fineract)
130+
- Gradle (wrapper included in the repository)
131+
132+
### Steps
133+
134+
1. Open IntelliJ IDEA and select **Open**
135+
2. Choose the root `fineract` directory
136+
3. When prompted, import the project as a **Gradle project**
137+
4. Use the Gradle wrapper (`gradlew`) when asked
138+
5. Ensure the correct JDK is selected (**Java 17**)
139+
6. After import completes, run:
140+
- `org.apache.fineract.ServerApplication` as a **Java Application**
141+
142+
### Notes
143+
- IntelliJ may take several minutes to index the project on first open
144+
- If you encounter build issues, try running `./gradlew clean build` from the terminal
145+
114146
How to download Gradle wrapper
115147
---
116148
The file gradle/wrapper/gradle-wrapper.jar binary is checked into this projects Git source repository,

0 commit comments

Comments
 (0)