Prerequisites

This page provides a list of prerequisites that are required to run the project.

Please make sure you have all these prerequisites installed and correctly configured before proceeding with the project setup. This will help to ensure a smooth and efficient development experience.

Note

The installation instructions for the various tools and dependencies differ based on the operating system you are using. Please refer to the documentation links provided for each section.

Docker

In order to bootstrap the infrastructural dependencies required to run the project, you will need to have a working installation of Docker.

This includes the following:

• Docker Compose
• Docker Engine

You can make use of the official documentation to install Docker Engine and Docker Compose.

Tip

You can also try out the Docker Desktop application, which includes both Docker Engine and Docker Compose (along with other useful tools as well).

The following are the versions I used for the project:

Docker Compose

➜  ~ docker compose version

Docker Compose version v2.24.6

Docker Engine

➜  ~ docker -v

Docker version 25.0.3, build 4debf41

If you have these versions (or newer) installed, you should be good to go.

Java

The back-end API is built using Java and Spring Boot. You will need to have a working installation of Java in order to build and run the back-end API.

The project requires Java 21 or newer to be installed. This is the latest LTS (Long Term Support) release of Java as of the time of writing.

You can also make use of various different flavors of the Java JDK (Java Development Kit) such as OpenJDK, AdoptOpenJDK, Oracle JDK, AmazonCorretto, Microsoft OpenJDK, etc.

I made use of OpenJDK 21 LTS for the project.

Java Version

➜  ~ java -version

openjdk version "21.0.2" 2024-01-16
OpenJDK Runtime Environment Homebrew (build 21.0.2)
OpenJDK 64-Bit Server VM Homebrew (build 21.0.2, mixed mode, sharing)

Tip

If you make use of package managers such as Homebrew, you can install OpenJDK using the following Terminal command:

Homebrew Install Java

brew install openjdk@21

NodeJS

The front-end application is built using Angular and NodeJS. You will need to have a working installation of NodeJS in order to build and run the front-end application.

I made use of NodeJS 20.12.0 LTS for the project.

NodeJS Version

➜  ~ node -v

v20.12.0

You can make use of the official NodeJS website to download and install NodeJS.

Tip

If you make use of the Node Version Manager (NVM), you can install NodeJS using the following commands:

NVM list remote LTS versions

➜  ~ nvm ls-remote --lts

NVM Install NodeJS

➜  ~ nvm install --lts

Angular CLI

The front-end application is built using Angular. You will need to have a working installation of the Angular CLI in order to build and run the front-end application.

You can install the Angular CLI using the following command:

npm install -g @angular/cli

You can verify the installed version of the Angular CLI using the following command:

ng version

Which should output something similar to the following:

Angular CLI: 17.3.2
Node: 20.12.0
Package Manager: npm 10.4.0
OS: darwin arm64

HTTP tools

In order to test the back-end API, you will need to have some form of HTTP tooling installed. Examples of such tools include:

• Postman
• Insomnia
• cURL
• HTTPie