Fix make commands and instructions (#208)

Author: mmwinther

Makefile

@@ -1,28 +1,56 @@
+SHELL=/bin/zsh
+MVN_AVAILABLE := $(shell command -v mvn 2> /dev/null)
+SDK_AVAILABLE := $(shell [[ -s "${HOME}/.sdkman/bin/sdkman-init.sh" ]] && source "${HOME}/.sdkman/bin/sdkman-init.sh" && command -v sdk)
+sdk = source "${HOME}/.sdkman/bin/sdkman-init.sh" && sdk
+
+.PHONY: check
+check:
+ifndef MVN_AVAILABLE
+	$(error "Maven is not available. Please install it before continuing.")
+endif
+ifndef SDK_AVAILABLE
+	$(error "Sdkman is not available. Please install it before continuing.")
+endif
+	@echo "Tools installed and ready"
+
+
 .PHONY: default
 default: | help
 
 .PHONY: help
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: build-all
-build-all:
-	mvn -B clean install --settings=.maven.settings.xml --file pom.xml -DskipTests -P nexus
+.PHONY: build-klass-forvaltning
+build-klass-forvaltning:
+	pushd klass-forvaltning && \
+	${sdk} env && \
+	mvn -B install -P nexus; \
+	popd; \
+	${sdk} env clear
+
+.PHONY: build-klass-api
+build-klass-api:
+	pushd klass-api && \
+	mvn -B install -P nexus; \
+ 	popd
 
 .PHONY: run-klass-forvaltning-local
 run-klass-forvaltning-local:
-	pushd klass-forvaltning && mvn spring-boot\:run --settings=../.maven.settings.xml -P nexus && popd
+	pushd klass-forvaltning && \
+	mvn spring-boot\:run --settings=../.maven.settings.xml -P nexus; \
+	popd
 
 .PHONY: run-klass-forvaltning-local-mariadb
 # Requires that a MariaDB instance is already running with a database called klass and a user called klass.
 # The environment variable KLASS_ENV_MARIADB_PASSWORD must be specified with the password for the klass user.
 run-klass-forvaltning-local-mariadb:
 	pushd klass-forvaltning && \
-	mvn spring-boot\:run -Dspring.profiles.active=mariadb,embedded-solr,frontend,skip-indexing,small-import,ad-offline -P nexus && \
+	mvn spring-boot\:run -Dspring.profiles.active=mariadb,embedded-solr,frontend,skip-indexing,small-import,ad-offline -P nexus; \
 	popd
 
 # The environment variable KLASS_ENV_SECURITY_IGNORED must be set to "/**" in order to skip authentication
 run-klass-api-local-mariadb:
 	pushd klass-api && \
-	mvn spring-boot\:run -Dspring.profiles.active=mariadb,embedded-solr,mock-mailserver,skip-indexing,small-import,ad-offline -P nexus && \
+	mvn spring-boot\:run -Dspring.profiles.active=mariadb,embedded-solr,mock-mailserver,skip-indexing,small-import,ad-offline -P nexus; \
 	popd

README.md

@@ -15,7 +15,7 @@ Klass consists of 4 maven modules
 - Klass Shared (Classes shared between API and Forvaltning. primary database and search components)
 - Klass Solr (Solr Core configuration  and configuration for embedded solr for test/development)
 
-### Build and Deploy
+## Build and Deploy
 
 Building the project will output  war files for **Klass API** & **Klass Forvaltning** and a zip file (WiP) for **Klass Solr**.
 
@@ -27,7 +27,7 @@ klass-forvaltning/target/klass-forvaltning-{Version}.war
 klass-solr/klass-solr-{Version}.zip (WiP)
 ```
 
-#### Server configuration
+## Server configuration
 
 Klass was made with Tomcat in mind and configuration on servers are done in `tomcat.conf` (usually found in ~tomcat/conf)
 variables in `application properties` will be overridden/replaced with properties found in `tomcat.conf`
@@ -44,7 +44,7 @@ KLASS_ENV_MARIADB_PASSWORD=Password
 KLASS_ENV_LOGGING_PATH=/var/log/tomcat
 ```
 
-### Database
+## Database
 
 Klass is configured to use Flyway for database initialising and  migration.
 You can find the collection of SQL scripts in the Klass-shared module under `src/main/resources/db/migration`
@@ -54,15 +54,30 @@ This process can take quite some time as there is a lot of data and its also sen
 
 Tips: If you are only setting up Klass for testing/development purposes you can use the `small-import` spring profile to reduce the amount of data being imported.
 
-### Development
+## Development
 
-its recommended to build with maven before starting development as some classes are generated as part of the build process.
+### Requirements
 
-```shell
-make build-all
-```
+- Maven: <https://maven.apache.org/install.html>
+- Sdkman: <https://sdkman.io/install>
+- Java 17: `sdk install java 17.0.11-zulu`
+- Java 8 (for Klass Forvaltning): `sdk install java 8.0.372-zulu`
+
+### Introduction
+
+It's recommended to build with maven before starting development as some classes are generated as part of the build process.
+
+Each app has an `.sdkmanrc` file which may be used to configure the Java version to use. This may be activated by entering the directory and running the `sdk env` command. A `Makefile` is also provided with relevant commands for building each app. See <https://sdkman.io/usage#env-command> for more details
+
+### Klass API
+
+Build the app: `make build-klass-api`
+
+### Klass Forvaltning
+
+Build the app: `make build-klass-forvaltning`
 
-#### Spring profiles
+### Spring profiles
 
 Klass API and Klass Forvaltning utilize Spring boot and heavily rely on Spring Profiles to make development and debugging easier.
 below is a quick summary of the profiles available (see _application.properties_ for more details)
@@ -84,7 +99,7 @@ below is a quick summary of the profiles available (see _application.properties_
 #   embedded-solr       = run an instance of solr as part of the application (no need to run a separate solr application)
 ```
 
-#### Build profiles
+### Build profiles
 
 we have created custom profiles for time consuming tests that can be toggled on and off to help speed up compile time during development.
 The profile named `documentation` will generate API documentation with AsciiDoc (default: enabled)

klass-api/.sdkmanrc

@@ -0,0 +1,3 @@
+# Enable auto-env through the sdkman_auto_env config
+# Add key=value pairs of SDKs to use below
+java=17.0.11-zulu

klass-forvaltning/.sdkmanrc

@@ -0,0 +1,3 @@
+# Enable auto-env through the sdkman_auto_env config
+# Add key=value pairs of SDKs to use below
+java=8.0.372-zulu