Skip to content

Commit 6ad221e

Browse files
committed
Add readme
1 parent c370fe9 commit 6ad221e

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
# swe-be-coding-interview
1+
# Software Engineer Backend Coding Challenge
2+
3+
## Requirements
4+
* JDK 21
5+
6+
## Local Setup
7+
8+
**Running the Application using IntelliJ IDEA:**
9+
10+
1. Clone this repository
11+
2. Import the project as a new project in IntelliJ
12+
3. Navigate to `GetYourGuideApplication.java` and run the main method by clicking the top green arrow on the left side of the editor.
13+
14+
![IntelliJ Run Screenshot](resources/intellij_screenshot.png)
15+
16+
**Running the Application using Gradle**
17+
18+
Note: We recommend running the application using IntelliJ IDEA so you can leverage its' debug tooling.
19+
20+
1. Clone this repository
21+
2. Navigate to the project directory in your terminal
22+
3. Run the following command: `./gradlew bootRun`
23+
24+
The application endpoints will be accessible on `http://localhost:8080/`.

0 commit comments

Comments
 (0)