Jems core development

Purpose: The purpose of this document is to provide an overview of how to build a Jems service based on the codebase provided by Interact.

Introduction

Every Programme may need to apply programme specific requirements to the Jems service. Jems provides an option to enhance the service according to your specific requirements.

Operation system requirements

To build a Jems service, it is recommended to use the following OS 

Linux platform (Kernel 4.x or higher)

Build package requirements

It is required to install the packages listed below for a successful build of the Jems service

OpenJDK Runtime Environment 11
MariaDB 10.3.13
Elasticsearch 7.10.2
MinIO RELEASE.2021-08-05T22-01-19Z
Gradle 6.3
Npm 6.14
Docker 19.03
Docker Compose 1.25
Kotlin
Springboot
Angular 9

Build instructions

Source code check out

The build of the Jems Service requires the latest version of the source code provided by Interact. It can be found under the following URL:

If you cannot access the mentioned repository, please contact the Interact Jems team: jems@interact-eu.net.

Kindly provide your programme name in the message.

Installation of the packages with Docker Compose

We, as a service provider, would like you to use the Docker approach to install and maintain the packages components.

Every Jems service source code package includes a docker-compose.yml file which contains instructions of how to set up the packages dependencies.

Please get in touch with the Docker Compose package provider to clarify how to manage its installation and what the prerequisites for the Docker Compose usage are.

The Docker Compose file will install the following set of packages:

·         MariaDB 10.3.13

·         Elasticsearch 7.10.2

·         MinIO RELEASE.2021-08-05T22-01-19Z

Installation of the build tools

After the successful deployment of the Docker Compose packages, the build tools listed below need to be installed:

 ·        OpenJDK Runtime Environment 11

·         Gradle 6.3

·         Npm 6.14

·         Angular 9

Please follow the instructions of the package provider during the installation process.

After the packages have been installed, you should manage the Gradle build properties.

For a successful build, the external Gradle plugin needs to be downloaded once via the specified repository.

To retrieve the token please contact the Jems team: jems@interact-eu.net.

Development

After the successful installation of all required components, you may import source code in an appropriate IDE.

To ensure that the build works, we recommend you to contact a person who is familiar with the following tools and frameworks:

·         Java / Kotlin

·         Spring Boot

·         Angular

·         Gradle

Development recommendations

To build the Jems service project, execute the commands listed below.

To access your service running on port 8080, please ensure to open your access by changing the firewall rules.