DevelopersGuide - OpenESignForms/openesignforms GitHub Wiki

Guide to setting up the development environment for extending and/or customizing Open eSignForms.

This guide is a work in progress! Please visit the GitHub wikis for full instructions. Note that this guide was not written by Yozons.

Introduction

This guide walks you step-by-step to setting up the programming environment for developing Open eSignForms. Updated for Java 8.

This guide assumes you will be developing on a Microsoft Windows operating system.

Setup the Environment

Apache Tomcat

  • We recommend using the latest stable version of Tomcat 8.
    1. Download the windows zip file (not the installer) and extract it to a folder on your computer

Eclipse IDE

  • We recommend using Eclipse IDE although these instructions should work for other IDE systems (eg. Netbeans) as well.
    1. Download and Install Eclipse IDE for Java EE Developers. We are using Eclipse Kepler version 4.3.2 (the latest available at this time of writing).
    2. Unzip all files to C:\Program Files

Configure the IDE

  • Launch the software from the install directory
    1. C:\Program Files\eclipse\eclipse.exe
    2. Set Workspace to C:\project
    3. Check the box use this as the default and do not ask again

Java 8

  • Install the latest version of the Java SE Development kit.
    1. Download Java SE Development Kit 8 (JDK 8) from Oracle's website.
    2. Download Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files
    3. Extract the two jar files into C:\Program Files\Java\jdk1.8.0\jre\lib\security folder, overwriting the files presently there.
    4. Extract the two jar files into C:\Program Files\Java\jre8\lib\security. Overwriting the files presently there.

Install IvyDE plugin

  1. In Eclipse, Click the Help > Install New Software... menu
  2. In the box Work With: type http://www.apache.org/dist/ant/ivyde/updatesite and click the Add button
  3. Give it the name Apache Ivy Update Site and click OK.
  4. Select everything except the Apache IvyDE Resolve Visualizer and click Next
  5. Accept the license, click Next followed by Finish to complete the installation. (click OK if you receive a warning about installing unsigned software)
  6. Do NOT restart when prompted as we will install Vaadin next

Install Vaadin

  • We will install the latest stable version, Vaadin 7 for the purpose of this guide.
  1. Click the Help > Install New Software... menu
  2. In the box Work With: type http://vaadin.com/eclipse
  3. Give it the name Vaadin Update Site and click OK
  4. Select the Vaadin Plug-in for Eclipse and click Next
  5. Review the package and accept the license agreement by clicking Next and then Finish
  6. Restart the IDE when prompted after the installation is completed

Cygwin

  • Perform a fresh install by running the setup program.
    1. When prompted, choose a download source "Install from Internet"
    2. We recommend leaving the default install directory C:\cygwin64 if you are installing on a 64-bit system.
    3. Change the local package directory to C:\packages
    4. Choose a download site (we recommend staying away from .jp domain names or similar unless you live in that country)
    5. Click next on the select packages screen
    6. Let the install process resolve any dependencies and click Next

PostgreSQL

  • Download the graphical installer
    1. Leave the default install drectory as C:\Program Files\PostgreSQL\9.3
    2. Leave the default data directory as C:\Program Files\PostgreSQL\9.3\data
    3. If you will only be developing Open eSignForms go ahead and type esignforms as the postgres database superuser password.
    4. Leave the default of 5432 as the port number the server should listen on
    5. Leave the default locale as [Default locale]
    6. Uncheck the checkbox to "launch Stack Builder at exit".

Check Out the Code

http://i58.tinypic.com/10ok6eh.jpg http://i60.tinypic.com/344cr55.jpg http://i62.tinypic.com/2i8dsts.jpg