Development Environment

Introduction

This section describes the steps you will need to take, and the tools you will need to install, to setup a basic Keep development environment. The steps listed here should be done in this order, as each step generally depends on the step before it.

  1. Setup Notes: Install Notes 11 and connect it to your Mail server.

  2. Setup Java 8: Install the OpenJDK version of Java 8 and configure it to run Keep builds. (Java 8, not 7– or 9++)

  3. Setup Git: Download the Keep source code from Git. Pro Tip: Use a GUI

  4. Setup Eclipse (optional) You can use any IDE you fancy.

  5. Run a Maven Build: Set up a Maven build environment, so that you can build the Keep source code.

  6. Run Keep: Set up and configure the Keep runtime environment, so that you can run the Keep APIs on your local machine.

  7. Run Keep with Docker: Set up a Docker based Keep development environment.

  8. Test Data for Docker Keep: Set up test users and test data to use with your Keep Docker image.

  9. Admin User Interface Training: Learn to write code for the Admin User Interface.

Dependency checks

  • Execute mvn versions:display-dependency-updates to check for updated dependencies
  • Execute mvn versions:display-plugin-updates to check for newer plugins

Produce UML from PlantUML text files

Maven is setup to (manually) generate PlantUML diagrams for use in Maven sites. Unfortunately the plugin uses Java11, while keep is stuck on Domino’s Java8 so some manual steps are involved:

  • Source directory: src/main/plantuml all files *.txt
  • Target directory: src/site/resources/images/uml (so they can be used in site)
  • Temporarily witch to Java11
  • Execute mvn com.github.funthomas424242:plantuml-maven-plugin:generate
  • Execute mvn site to incorporate new images in site

Switching to Java11 on macOS

macOS allows multiple Java instances being installed, to switch you can repoint JAVA_HOME. When done in terminal the change only lasts for that terminal session.

  • Show Java versions available: /usr/libexec/java_home -V
  • Switch a version: `export JAVA_HOME=````/usr/libexec/java_home -v 11.0.4``` (Pick one of the previous displayed)