The following describes how to install and execute scream. This includes the setup of the necessary development environment.

• Install Java. v17 or better will work. Coretto 17.
• Install Maven. Maven 3.9.5. Use for example the .zip download.
• Install Git.

• Open a console on your OS.
• Check the Java installation. Enter:
  java --version
  This should print a banner that documents Java's version, no error message.
• Check the Maven installation. Enter:
  mvn --version. Again this should display a version banner, no error message.
• Check the git installation. Enter:
  git --version
  A version banner, no error message.

A PAT needs to be generated, the account name is also shown in this process.

The PAT can be generated in the following steps:

• On the main GitHub page, select your avatar (the icon representing your identity) at top right of the page.

• Select 'Settings' (near the bottom of the long list). This opens your personal account page that also shows your account name in the headline.

• Select 'Developer Settings' (again near the bottom).

• In the next page select 'Personal access tokens' -> 'Tokens (classic)'
  A page shows, offering a combo box 'Generate new token' in the top line.

• In the combo box select 'Generate new token (classic)'.

• In the following page

  • Add a note, configure the token expiration.
  • Select the scope read:packages.
  • Finally press the 'Generate token' button at the bottom of the page.

• In the following page the new token is shown. Note: The token is shown only one time! Copy the token.

An execution of mvn created a directory .m2 in your home directory.

• Change into that .m2 directory.
• Search for a file 'settings.xml', note that it is possible that it does not exist.

This file allows to configure the download permissions for scream's dependencies. These consist of your GitHub account name and a GitHub personal access token (PAT) that you created in the last chapter.

A username looks like peteparker, a PAT looks like ghp_5yp313IJjYB5AqLinvaLidhveYCyeYg313yoI.

If the file .m2/settings.xml does already exist add or extend the serverselement and replace the username and password with the acount name and PAT from the above:

  <servers>
    <server>
      <id>github</id>
      <username>peteparker</username>
      <password>ghp_5yp313IJjYB5AqLinvaLidhveYCyeYg313yoI</password>
    </server>
  </servers>

If this file does not exist, create it with the following content and place the account name and PAT in this file:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                          https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <localRepository />
  <interactiveMode />
  <offline />
  <pluginGroups />

  <servers>
    <server>
      <id>github</id>
      <username>peteparker</username>
      <password>ghp_5yp313IJjYB5AqLinvaLidhveYCyeYg313yoI</password>
    </server>
  </servers>

  <mirrors />
  <proxies />
  <profiles />
  <activeProfiles />
</settings>

• Open a console on your OS.
• Create a working directory at a convenient position.
• Switch into that directory.

• Clone the scream git-repository. Enter:
  git clone [email protected]:urschleim/scream.git. Note that the git URL may be sightly different depending on your configuration of git. If the command fails try git clone https://github.com/urschleim/scream.git.
  Expected is some progess information, no error message.
  The clone-command created a directory scream.

• Change in the console into the scream directory.
• Execute the command
  mvn install -DskipTests
  Enjoy loads of progress messages. Expect no error messages.

• Stay in the scream directory.

• Execute the command mvn exec:exec
• The scream UI should come up.

• The generated Java-classes are located in the directory target, with a name like scream-7.<version>.jar.
• Execute the following command using the scream-7.* name from above: java -jar target/scream-7...jar
• The scream UI should come up.