API

The api expects the following request:

Method	Location
POST	/api

Example body:

{
    "addresses": [
        "Amsterdam", 
        "Utrecht", 
        "Zwolle", 
        "Enschede"
    ]
}

---

Running the project locally

To run this project locally, you can use the provided dockerfile and docker-compose.yml
(If you have Docker and docker-compose installed).

Make sure you have exported this project as a .jar file and placed it inside the root folder. After that you can simply run docker compose up --build or docker-compose up --build for older docker versions

Development

DevContainer

It is recommended to open this project inside of a vscode DevContainer to make sure you're running the code inside the correct environment.

To do this, you need to have Docker installed and open this project in vscode.
Next, make sure you have the Docker and DevContainer extension installed.
Then press ctrl + shift + P and select Dev Containers: Reopen Folder Locally

Apache Maven

This project is managed using Apache Maven.

Project structure

src

The src folder includes all java classes. App.java is the main class.

pom.xml

The pom.xml file is the 'Project Object Model', which Maven uses to to get the necessary information about the project.