Skip to content

Commit efad03c

Browse files
committed
Added a getting started section in readme
1 parent f1e0330 commit efad03c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,25 @@ don't feel the pressure to supply values for all the fields. **Note:** Whenever
5959
using `Configuration` never forget to supply your `serverUrl` and `apiKey` using a `Configuration` object as
6060
shown above.
6161

62+
## Getting Started (Development)
63+
64+
### Intellij
65+
1. You will need to install:
66+
* [Intellij](https://www.jetbrains.com/idea/download/)
67+
* **Note:** In Intellij you can directly [download JDK 11 from the IDE](https://www.jetbrains.com/help/idea/sdk.html#jdk-from-ide). Intellij also comes with a bundled Maven installation and built-in Lombok support.
68+
2. Clone the repo
69+
3. Verify your setup using `mvn clean verify`
70+
71+
### VSCode
72+
1. You will need to install:
73+
* [VSCode](https://code.visualstudio.com/download)
74+
* [JDK 11](https://www.oracle.com/ie/java/technologies/javase-downloads.html). Make sure that your `java --version` and `$JAVA_HOME` environment variable point to the correct jdk.
75+
* [VSCode Java extension pack](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack)
76+
* [VSCode Lombok extension](https://marketplace.visualstudio.com/items?itemName=GabrielBB.vscode-lombok)
77+
2. Clone the repo
78+
3. Verify your setup using `mvn clean verify`
79+
80+
6281
## Spring Boot Users
6382

6483
You can observe `NoClassDefFoundError` in your Spring-boot apps because Spring-boot uses v3 of `OkHttpClient` while this

0 commit comments

Comments
 (0)