Follow the instructions below to set up the local environment for Komet:
- Download and install Open JDK Java 21
- Download and install Apache Maven 3.9 or greater
- Prior to building Komet, there are additional repositories to clone and build. Please use
the
tinkar-core
README file to build thetinkar-core
project and its prerequisites before buildingkomet
.
Follow the steps below to build and run Komet with JPro on your local machine:
- Clone the ikm-jpro repository from GitHub to your local machine
- Change local directory to location to
ikm-jpro
- Enter the following command to build the application:
mvn clean install
- Run the Komet application with JPro locally with the following command:
mvn -f application jpro:run
- The default web browser should automatically open and you should see Komet application running, otherwise just
navigate to
http://localhost:8080
in your web browser. - To stop the application, press
Ctrl + C
in the terminal window where the application is running. - To run the application again, repeat step 4.
- The application can also run as classic desktop JavaFX app with the following command:
mvn -f application javafx:run
Follow the steps below to run Komet with JPro in a Docker container:
- Clone the ikm-jpro repository from GitHub to your local machine
- Change local directory to location to
ikm-jpro
- Enter the following command to build the application:
mvn clean install
- Create the application release zip for deployment with the following command:
mvn clean -f application jpro:release
The application release zip will be built and the output will be in the application/target
directory, with the name
application-jpro.zip
.
5. Transfer the application-jpro.zip
file to the directory where you want to run the Docker container.
6. Extract the application-jpro.zip
content and change the directory to the unzipped directory.
7. Run the application in a docker container:
- Option 1: Build the Docker image and run the Docker container manually
- Inside the unzipped directory, there is a
Dockerfile
file. Create a Docker image with the following command:docker build -t komet-jpro .
- Run the Docker container with the following command:
Note:
docker run -d -v ~/Solor:/root/Solor -p 8080:8080 komet-jpro
-v ~/Solor:/root/Solor
: This option mounts a volume. It creates a mapping between a directory on the host machine and a directory inside the container.- ~/Solor: This is the path to the directory on the host machine (or your local system). The
~
is a shorthand for the current user’s home directory. This path should be the directory where the dataset is located. - /root/Solor: This is the path inside the container where the host directory will be mounted. Anything in ~/Solor on the host will be accessible inside the container at /root/Solor.
- ~/Solor: This is the path to the directory on the host machine (or your local system). The
- Inside the unzipped directory, there is a
- Option 2: Use Docker Compose to run the Docker container
- Inside the unzipped directory, there is a
docker-compose.yml
file. You can use this file to run the Docker container with Docker Compose. To run the Docker container with Docker Compose, use the following command:docker-compose up -d
- Inside the unzipped directory, there is a
- The application should be running in the Docker container. To access the application, open a web browser and navigate
to
http://localhost:8080
if you are running the Docker container locally. If you are running the Docker container on a remote server, replacelocalhost
with the IP address of the server.
Note: Komet requires sample data to operate with full functionality