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.
Setup HCL Notes: Install Notes and connect it to your Mail server.
Setup Java 8: Install the OpenJDK version of Java 8 and configure it to run KEEP builds. (Java 8, not 7– or 9++)
Setup Eclipse (optional) You can use any IDE you fancy.
Run a Maven Build: Set up a Maven build environment, so that you can build the KEEP source code.
Run KEEP: Set up and configure the KEEP runtime environment, so that you can run the KEEP APIs on your local machine.
Run KEEP with Docker: Set up a Docker based KEEP development environment.
Test Data for Docker KEEP: Set up test users and test data to use with your KEEP Docker image.
Admin User Interface Training: Learn to write code for the Admin User Interface.
mvn versions:display-dependency-updatesto check for updated dependencies
mvn versions:display-plugin-updatesto check for newer plugins
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:
- Target directory:
src/site/resource/assets/images/uml(so they can be used in site)
- Temporarily witch to Java11
mvn siteto incorporate new images in site
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:
- Switch a version:
/usr/libexec/java_home -v 11.0.4(Pick one of the previous displayed)
Table of contents
- Setup Notes 12
- Setup Java 8
- Setup Source Code
- Setup SourceTree
- Setup Eclipse
- Run a Maven Build
- Run KEEP with Docker
- Run KEEP
- Test Data for Docker KEEP
- Admin User Interface