Installation Manual

Table of content

• Table of content
• Cloning the project
• Opening the project with Intellij IDEA
• Get the project up and running
  • Adding the database configuration
  • Setting up maven
  • Run the application

Cloning the project

There are some prerequisites for cloning the project.

• Git scm | Link to git download
• Java SDK 11 | Link to download Java
• Intellij IDEA | Link to Intellij IDEA download

Start off by creating a folder where you would like to save the project. Go into this folder and right click, you will get an option stating "Git bash here", which will open a new terminal. If you don't get the option you can navigate to the folder with the terminal (powershell/cmd/terminal).

In the terminal you will have to run the following command:

git clone https://gitlab.stud.idi.ntnu.no/eirsteir/team-14-software-engineering.git

This will create a new folder with the whole project inside.

Cloning the project from terimnal

Congratulation, you have now cloned the project!

Opening the project with Intellij IDEA

First time using Intellij IDEA

Start off by launching Intellij IDEA. You will be met by a welcome window with some options on the right. Choose open and navigate to the folder where you save the project and choose the project. The black box under the folder icon means that Intellij recognizes the project and you are on the right path.

Welcome screen where you should press "open"

Have used Intellij IDEA before Start off by launching Intellij IDEA. If you have used Intellij IDEA before it will most likely open you previous project. Start by clicking in the left corner on "file" -> "open". Navigate to the folder where you saved the project. The black box under the folder icon means that Intellij recognizes the project and you are on the right path.

Intellij recognizes the project

You will now get the project opened in Intellij.

Get the project up and running

There are some minor things you have to fix before getting the application up and running.

Adding the database configuration

On the right, in the file explorer, right click on "team-14-software-engineering" -> click on "New" -> click on "File". Name this file "config.properties". In this file fill out the following:

# Database Connection Properties
DB_DRIVER=com.mysql.cj.jdbc.Driver
DB_URL=jdbc:mysql://your_database_url_here
DB_USER=your_username_here
DB_PASSWORD=your_password_here
DB_DIALECT=org.hibernate.dialect.MySQL8Dialect

# Google Maps API Key
GOOGLE_API_KEY=your_google_maps_api_key_here

Setting up maven

In the top left corner press "File" -> "Project Structure". You will now get a new window, in this window go to "Project" in the left margin. Here you will have to choose your project SDK. Make sure that you are using 11 or higher. Press "Apply" then "Ok".

Right click on the "pom.xml" file -> "Add as maven project". It will now pop up a window from the right, stating "maven". In this window, right click and press "Reimport".

Run the application

Open the folder "Image Application" in the maven window -> open the "Plugins" folder -> Open the "JavaFX" folder -> click on "javafx:run".

If all the steps have been executed correctly the program will now start and you can use the application as you like. For more information on how to use the application please read the User Manual