Setting up your Environment

In this tutorial you will set up the development environment required to complete the tutorials in this course.

The instructions on this page assume you will be installing the Caplin Platform 7 on a 64-bit version of Windows 7 or Windows 10.

Objectives

In this tutorial, you will install the following components:

Install Oracle Java

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 Mac OS, see Installing Java.

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

Install a Gradle-compatible IDE

The tutorials in this course are compatible with the following IDEs:

Install Eclipse

To install Eclipse, follow the steps below:

  1. Download and install the Eclipse IDE for Java EE from the Eclipse IDE website.
  2. Launch Eclipse
  3. Click Help > Eclipse Marketplace
  4. Search for and install the Buildship Gradle Integration plugin

Install Cygwin

This section only applies if you are using Microsoft Windows. If you are using MacOS or Linux, then skip this section.

The Caplin Deployment Framework command-line tools require a Bash environment.

To install the Cygwin Bash environment for Microsoft Windows, 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 Cygwin installer, select the following additional packages: zip, unzip, vim, vim-common, dos2unix, and wget.

Editing text files in Cygwin

As part of this course, you will edit several configuration files belonging to the Caplin Deployment Framework. To do this, you can use either a Cygwin editor or a Windows text editor.

Cygwin text editor

Your installation of Cygwin includes the Vim text editor, a revision of the original Vi editor. Installing the Vim package on Cygwin replaces the Vi executable with a symlink to the Vim executable, and Vim can be launched by either typing vi or vim on the command line.

Note: in some Linux environments, the command vi opens Vim in a mode compatible with the original Vi. In recent versions of Cygwin, the commands vi and vim both open Vim in a mode incompatible with the original Vi. If you prefer a traditional Vi environment, then you can restore Vi compatiblity by entering the following command on the Cygwin command line: echo ':set compatible' > ~/.vimrc

If you are new to Vim, you may find the resources below useful:

Windows text editor

As an alternative to using Vim, you can use a GUI text editor such as Sublime Text, Atom, Brackets, or Notepad++.

Set your chosen text editor to use Unix-style line endings and UTF-8 character encoding.

Your Cygwin home directory is at the following location in the Windows filesystem: C:\cygwin64\home\windows_username

Customise the Cygwin Bash shell

If you are familiar with Bash and would like to customise Cygwin's shell, edit the file .bashrc in your Cygwin home directory.

The .bashrc file already contains a comprehensive selection of customisations that are commented-out by default. Customisations you may wish to uncomment are listed below:

  • alias grep='grep --color'
  • alias egrep='egrep --color=auto'
  • alias fgrep='fgrep --color=auto'
  • alias ls='ls -hF --color=tty'
  • alias dir='ls --color=auto --format=vertical'

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.

To download the redistributable, see The latest supported Visual C++ downloads on the Microsoft website.

Install Google Chrome

Install the Google Chrome web browser.