Skip to content

Releases: cathrkri/systemutviklingTeam6

First Release of HmH

24 Apr 11:02
Compare
Choose a tag to compare

Installation Guide — HmH Application (Team 6)

Prerequisites

Required

Tool Version Download
Java Development Kit (JDK) 25 (LTS) oracle.com/java/technologies/downloads/#java25
Apache Maven 3.9 or later (only if your IDE does not include Maven) maven.apache.org/download.cgi

Tip: An IDE with built-in Maven support (e.g. IntelliJ IDEA) is recommended, as Maven does not need to be installed separately.


Verifying Prerequisites

After installing, confirm each tool is available in your system PATH.

Java

java -version

Expected output: Java version 25.

Maven

mvn -version

Expected output: Maven version 3.9 or later.

Skip this step if your IDE bundles Maven. You can verify it works by importing the project and checking that dependencies resolve correctly.

Git (optional)

git --version

Expected output: version 2.53 or higher.


Installation Steps

If you run into problems at any step, refer to the Troubleshooting section.

1. Obtain the Source Code

The source code is hosted at: https://git.ntnu.no/cathrkri/systemutviklingTeam6

Click the green Code button. You will see five options:

  • HTTPS
  • SSH (recommended)
  • GitHub CLI
  • Open with GitHub Desktop
  • Download ZIP (simplest option)

Simple Install — Download ZIP

Click Download ZIP and unzip the file to a location you will remember.

Recommended Install — Clone via SSH

SSH cloning requires an existing SSH key pair. If you do not have one, follow NTNU's SSH key guide.

Once you have a valid key pair:

  1. Select SSH under the Code button.
  2. Click the copy icon next to the URL.
  3. Open a terminal and run:
git clone <SSH-URL>

The repository will be cloned to your current working directory.

Example (Windows 11 Command Prompt):

C:\Users\Roar> git clone git@git.ntnu.no:cathrkri/systemutviklingTeam6.git
# Repository saved to: C:\Users\Roar\systemutviklingTeam6

If Git is not installed locally, you can run the same git clone command in your IDE's built-in terminal.


2. Build the Application

Using an IDE (e.g. IntelliJ IDEA)

  1. Open your IDE and select Open, then navigate to the systemutviklingTeam6 folder.
  2. Inside the project, open the helpmehelpapplication folder.
  3. Right-click pom.xml and select Add as Maven Project.
    • This will download all required dependencies automatically.
  4. Once dependencies are resolved, run the application from the terminal:
mvn clean javafx:run

The application will build and launch.


Troubleshooting

(Refer to this section if you encounter issues during installation or startup.)

  • Ensure java -version returns version 25. Older JDK versions are not supported.
  • If Maven cannot resolve dependencies, check your internet connection and confirm the pom.xml was added correctly as a Maven project.
  • For SSH cloning issues, verify your SSH key is registered with your git.ntnu.no account.
# Installation Guide — HmH Application (Team 6)

Prerequisites

Required

Tool Version Download
Java Development Kit (JDK) 25 (LTS) [oracle.com/java/technologies/downloads/#java25](https://www.oracle.com/java/technologies/downloads/#java25)
Apache Maven 3.9 or later (only if your IDE does not include Maven) [maven.apache.org/download.cgi](https://maven.apache.org/download.cgi)

Optional (Recommended)

Tool Version Download
Git 2.53 or later [git-scm.com/install](https://git-scm.com/install/)
IntelliJ IDEA (Community or Ultimate) Latest [jetbrains.com/idea/download](https://www.jetbrains.com/idea/download/)

Tip: An IDE with built-in Maven support (e.g. IntelliJ IDEA) is recommended, as Maven does not need to be installed separately.


Verifying Prerequisites

After installing, confirm each tool is available in your system PATH.

Java

java -version

Expected output: Java version 25.

Maven

mvn -version

Expected output: Maven version 3.9 or later.

Skip this step if your IDE bundles Maven. You can verify it works by importing the project and checking that dependencies resolve correctly.

Git (optional)

git --version

Expected output: version 2.53 or higher.


Installation Steps

If you run into problems at any step, refer to the [Troubleshooting](#troubleshooting) section.

1. Obtain the Source Code

The source code is hosted at:
https://git.ntnu.no/cathrkri/systemutviklingTeam6

Click the green Code button. You will see five options:

  • HTTPS
  • SSH (recommended)
  • GitHub CLI
  • Open with GitHub Desktop
  • Download ZIP (simplest option)

Simple Install — Download ZIP

Click Download ZIP and unzip the file to a location you will remember.

Recommended Install — Clone via SSH

SSH cloning requires an existing SSH key pair. If you do not have one, follow [NTNU's SSH key guide](https://wiki.math.ntnu.no/drift/help/using_ssh_keys).

Once you have a valid key pair:

  1. Select SSH under the Code button.
  2. Click the copy icon next to the URL.
  3. Open a terminal and run:
git clone <SSH-URL>

The repository will be cloned to your current working directory.

Example (Windows 11 Command Prompt):

C:\Users\Roar> git clone git@git.ntnu.no:cathrkri/systemutviklingTeam6.git
# Repository saved to: C:\Users\Roar\systemutviklingTeam6

If Git is not installed locally, you can run the same git clone command in your IDE's built-in terminal.


2. Build the Application

Using an IDE (e.g. IntelliJ IDEA)

  1. Open your IDE and select Open, then navigate to the systemutviklingTeam6 folder.
  2. Inside the project, open the helpmehelpapplication folder.
  3. Right-click pom.xml and select Add as Maven Project.
    • This will download all required dependencies automatically.
  4. Once dependencies are resolved, run the application from the terminal:
mvn clean javafx:run

The application will build and launch.


Troubleshooting

(Refer to this section if you encounter issues during installation or startup.)

  • Ensure java -version returns version 25. Older JDK versions are not supported.
  • If Maven cannot resolve dependencies, check your internet connection and confirm the pom.xml was added correctly as a Maven project.
  • For SSH cloning issues, verify your SSH key is registered with your git.ntnu.no account.

Noteworthy

Account already registered in the database:
Test