Setting up the Development Environment

In this preliminary tutorial you will set up a Caplin Platform 7 development environment on Microsoft Windows, which you will use to complete the tutorials in this course.

You can also complete the tutorials using macOS or Linux.

Objectives

In this tutorial, you will install the following components:

Install Oracle Java 8

Follow the steps below:

  1. Download and install the Oracle Java 8 64-bit JDK

  2. Set the JAVA_HOME environment to the root of the JDK’s installation directory

For detailed instructions on installing Java on Microsoft Windows, Red Hat Linux, and macOS, see Installing Java.

There may be an issue with some versions of Oracle Java and macOS. See Installing Java for more details.

Install Eclipse or IntelliJ IDEA

The tutorials in this course require an IDE with Gradle integration. Eclipse and IntelliJ IDEA are used as examples.

Install Google Chrome

The tutorials require a web browser that includes comprehensive developer tools. Google Chrome is used as an example.

Install the Google Chrome web browser.

Install Cygwin or Git Bash

This section only applies if you are using Microsoft Windows.

The Caplin Platform is designed to run in a Bash shell and supports the following Bash shells on Windows:

  • Cygwin

  • Git Bash (an MSYS2 shell distributed with Git for Windows)

Bash symlinks and Windows

The Caplin Platform makes extensive use of Bash symlinks. Cygwin and Git Bash can implement Bash symlinks in the Windows NTFS filesystem in one of four ways: so-called 'magic cookie' files, Windows shortcut files (*.lnk), NTFS junctions, or NTFS symlinks. Cygwin and Git Bash provide control over which implementation is used via the winsymlinks option of the CYGWIN and MSYS environment variables respectively.

The Caplin Platform on Windows requires Bash symlinks to be implemented as Windows shortcut files.

Cygwin

To install Cygwin, follow the steps below:

  1. Download the Cygwin installer from the Cygwin website.

  2. Run the Cygwin installer and follow the installation instructions on the Cygwin website.

    When prompted by the installer, select the following additional packages: zip, unzip, vim, vim-common, dos2unix, wget, and curl.

  3. After installation, open a Cygwin terminal and run the command below to configure Cygwin to implement Bash symlinks as Windows shortcuts:

    echo CYGWIN=winsymlinks >> ~/.bashrc
    Alternatively, if you don’t want to set CYGWIN=winsymlinks globally, then you can set it temporarily when unzipping the Deployment Framework. See Installing the Deployment Framework in the first tutorial.
  4. Close the Cygwin terminal

Git Bash

Git Bash is included with Git for Windows. If you already have Git for Windows installed, skip to step 3 in the installation instructions below.

The Git for Windows installer requires you to have a knowledge of Git configuration options, so the instructions below include a list of settings commonly used by Windows developers in mixed-OS environments. If you have already installed Git for Windows, you do not need to adjust your Git configuration to suit the example Git settings below.

To install Git for Windows, follow the steps below:

  1. Install Notepad++. Notepad++ is a better option (than Vim) for Git’s default editor on Windows if you want to use Git from both Git Bash and from the Windows command prompt (see the options below).

  2. Run the Git for Windows installer, and select the following Git configuration options when prompted:

    • 'Choosing the default editor used by Git': Use Notepad++

    • 'Adjusting your PATH environment': Use Git from the Windows Command Prompt

    • 'Choosing the SSH executable': Use OpenSSH

    • 'Choosing HTTPS transport backend': Use the OpenSSL library

    • 'Configuring the line ending conventions': Checkout as-is, commit Unix-style line endings

    • 'Configuring the terminal emulator': Use MinTTY

    • 'Configuring extra options': Enable file system caching and Enable Git Credential Manager

      The extra option Enable symbolic links is not required by the Caplin Platform on Windows. This option configures the git command on Windows to implement Bash symbolic links as NTFS native symbolic links. This option requires Windows 10, local Administrator privileges, and a new group policy entry (SeCreateSymbolicLinkPrivilege).
  3. After installation, open a Git Bash terminal and run the command below to configure Git Bash to implement Bash symlinks as Windows shortcuts:

    echo MSYS=winsymlinks >> ~/.bashrc
    Alternatively, if you don’t want to set MSYS=winsymlinks globally, then you can set it temporarily when unzipping the Deployment Framework. See Installing the Deployment Framework in the first tutorial.
  4. Close the Git Bash terminal

If you added MSYS=winsymlinks to the file ~/.bashrc in step 3, then the next time you open a Git Bash terminal, Git Bash will warn you that it has automatically created a Bash ~/bash_profile file. You can safely ignore this warning.

Install Microsoft Visual C++ Redistributable for Visual Studio 2015

The Windows versions of Liberator and Transformer require the Microsoft Visual C++ Redistributable for Visual Studio 2015.

The installer is available at The latest supported Visual C++ downloads on the Microsoft website.