Project Setup Guide

This is the new guide for all versions since to 0.5.4 !

1. VCS Setup

The Project is distributed via Git and hosted by GitHub.
=> GitHub Homepage: https://github.com/

I recommend using the official GitHub Client for Windows or Mac, which can be found on the GitHub Homepage. Download and install it. You may also need to create a GitHub account during installation.

To clone the repository to your local GitHub client, just open the projects URL and drag and drop the URL from your browser into the GitHub client. This will download the project into a folder based on your client configuration.

2. Prerequisites

To run the application you must have Java 12 JDK (or up to 15) installed, which can be downloaded for example at AdoptOpenJDK. You will also need to install a recent version of NodeJS and NPM (on windows, the Nodejs installer should come with NPM).

3. Build

This project uses Gradle as a build tool. The project files include the Gradle Wrapper, which allows you to run the build without manually installing Gradle.

• To be able to login once the application is started, you first need to do a simple configuration change to allow creation of a default user account on startup. Inside the project folder, navigate to src/main/resources, open the file default.properties and edit it so that default.user is set to true.

• Then navigate to the project folder and use a shell to execute gradlew buildFrontend to build the frontend code and after it has finished, gradlew appRun to build the backend code, start an embedded Java server and deploy the webapp to the server. On windows, use gradlew.bat instead of gradlew.

  • For both commands you should see the console logging output from gradle and gulp while the project is getting built/run. When doing this for the first time, this may take several minutes. After the build has successfully completed, you should see the logs from the embedded tomcat server starting up and initializing the project servlet.

• Now open your browser and type localhost:8080/GMM in the browsers adress bar. You should then see the applications login screen. Use the default user account with name "admin" and password "admin" to login.