Setup

For the this template you need to install

1. Java 21
2. VsCode
3. Maven
4. Git

on your computer.

WINDOWS

• First, install Chocolatey for easier package and Software installation:

  • open powershell as administrator (right-click: open as administrator) and run:

    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

  • Once the installation is completed, close the Powershell (Admin) or Terminal (Admin) and open it again and run the following commands:

• Temurin 21

  • via Chocolatey (recommended):

    choco install Temurin21

• Visual Studio Code

  • via chocolatey (recommended):

    choco install vscode

• VSCode Java extension pack

• Maven

  • via chocolatey (recommended):

    choco install maven

  • or via installer (slower): (https://maven.apache.org/install.html)

• Git

  • via chocolatey (recommended):

    choco install git

  • or via their website: (https://git-scm.com/book/de/v2/Erste-Schritte-Git-installieren)

• If you used chocolatey for installation, you can use the command

  choco list

• if all installations worked, the output should look like this:

  maven 3.9.9
  Temurin21 21.0.0
  vscode 1.95.2
  vscode.install 1.95.2
  git 2.49.0

MACOS

• Homebrew (If wanted)

  • If wanted you can use homebrew to complete the following installation steps. Homebrew is a unofficial package manager for macOS, which should help you with installing new software on your system. To get started with homebrew just paste the following command inside your terminal window:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    

• Java 21

  • via brew:

    brew install --cask temurin
    

• Visual Studio Code

  • Either via installer: Visual Studio Code Installer

    1. Download the vscode App from the official website.

    2. Install the app on your system. Simply drag and drop the downloaded *.app file into your Applications folder.

  • Or via brew:

    brew install --cask visual-studio-code
    

• VSCode Java extension pack

• Maven

  • Either manually using these setup instructions: Maven - Installing
  • Or via brew:

    brew install maven
    

• Git

  • via brew (recommended):

    brew install git
    

  • or via their website: (https://git-scm.com/book/de/v2/Erste-Schritte-Git-installieren)

UBUNTU

• Java Open JDK 21

  sudo apt install temurin21

• Visual Studio Code

  • Either via installer: Visual Studio Code Installer
  • Or via snap:

    sudo snap install code --classic

• VSCode Java extension pack

• Maven

  sudo apt install maven

• Git

  • via bash (recommended):

    sudo apt install git

  • or via their website: (https://git-scm.com/book/de/v2/Erste-Schritte-Git-installieren)

Setup VsCode (do not skip this step!)

1. Click on the "Extension" Icon in the left panel

2. search for java extension pack in the search field click on the first entry (NOTE: check that the distributor is MICROSOFT and no-one else) and click on the Install button to installer the extension pack. Wait until all extensions are installed.

You can check if your installations of java and maven were successful by typing

mvn --version

into your local terminal.

Using this repo

1. In GitHub: Click on "Use this template", blue button top right. Choose "Create a new repository" and enter a sensible name.

2. After your new repo opens, click on "<> Code", blue button top right. Copy the Web URL.

3. Open VSCode, Press Crtl + Shift + E, choose "Clone Repository" and enter the copied URL into the field at the top of the IDE. Choose a local folder and open the folder.

4. Trust the authors and Open Terminal -> New Terminal.

5. enter mvn test to run the tests in the repo.