Prerequisites

This isn't the type of blog where you copy some already generated files to a server. Rather, you generate the files yourself. There are a few things that need to be installed in order to do this.

---

macOS

Homebrew

Homebrew needs to be installed. Be sure that the command brew doctor says

Your system is ready to brew.

Next, run the following commands for the backend and frontend.

Backend

brew install maven

sudo ln -sfn /usr/local/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk

Frontend

brew install node

npm install -g @angular/cli@^8

---

Debian / Ubuntu

Simply run the following commands:

sudo apt update
sudo apt install maven nodejs git
sudo npm install -g @angular/cli@^8

---

Windows 10

The following programs need to be installed:

Git

Go to the Git website and download & install the Latest source Release.

Backend

OpenJDK

Go to the OpenJDK website and download the Windows/x64 zip file.

In File Explorer, navigate to the openjdk zip file that was downloaded, probably in the Downloads folder, and open it. Next, right click and choose Copy on jdk folder. Navigate to C:\Program Files and paste the copied folder.

Maven

Got to the Apache Maven Project website and download the Binary zip archive.

In File Explorer, navigate to the apache-maven zip file that was downloaded, probably in the Downloads folder, and open it. Next, right click and choose Copy on apache-maven folder. Navigate to C:\Program Files and paste the copied folder.

Environment Variables

JAVA_HOME needs to be created and PATH needs to be updated.

Open up System Properties (WinKey + Pause) and click on Advanced system settings followed by Environment Variables.... Under User variables click on the New... button. For variable name, type JAVA_HOME. Then click on the Browse Direcotry... button and go to This PC -> OS (C:) -> Program Files and select the jdk folder. Click on the OK buttons, twice, to close the windows.

Next, select the Path user variable and click on the Edit... followed by the New button. Type in the location of the apache-maven\bin folder. For me, I typed in C:\Program Files\apache-maven-3.6.3\bin. Click on the OK buttons, three times, to close the windows. Close the System Properties window as well.

Finally, test that everything is setup correctly by opening the Git Bash program (installed above) and executing the command mvn -v. The output should look something like:

Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: C:\Program Files\apache-maven-3.6.3
Java version: 14.0.2, vendor: Oracle Corporation, runtime: C:\Program Files\jdk-14.0.2
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 10", version: "10.0", arch: "amd64", family: "windows"

Frontend

First, download and install Node.js - the Current version.

Finally, run the following command:

npm install -g @angular/cli@^8

---

NOTE

Angular: The @anuglar/cli version number doesn't have to be locked in at 8. By default, if a higher version of Angular is installed, the lower version associated with this project will be used.

OpenJDK: There is nothing in the backend code base that locks the version to be 14. Version 8 and higher will work. Lower versions may work but have not been tested.