=======================================================
      
       Enterprise SOA Showcase

       Quick Start Guide

       Q-ImPrESS (c) 2008-2009

=======================================================



TABLE OF CONTENTS
-----------------
1. Prerequisites
2. Installation instructions
3. Showcase directory layout



1. PREREQUISITES
----------------
The following software have to be installed prior to installing the Showcase:

- Java SE Development Kit: v1.6
- Apache Ant: v1.7
- PostgreSQL: v8.3
- Apache Tomcat: v6.0

NOTE: Make sure that your installation paths do not contain spaces.

The Showcase uses Apache Ivy tool to download all required dependencies
from configured repositories during the build process. Make sure you
have an active Internet connection during the Showcase installation.

All Showcase applications will be deployed on a single Tomcat server.
This could cause memory overflow problems, as the default size of
PermGen space is set to 64MB on most VMs, which is insufficient for 
the Showcase applications installed altogether. To avoid this issue
you should increase PermGen size by specifying '-XX:PermSize=128M' 
in your Tomcat startup parameters (i.e. through JAVA_OPTS or CATALINA_OPTS).



2. INSTALLATION INSTRUCTIONS
----------------------------

1) Configure installation properties

The QImPrESS_Showcase directory contains build.properties.template file. 
Create build.properties file from it and set the required properties 
according to your configuration.

2) Run installation

Tomcat server should be started prior to running Showcase installation.

Run 'ant install-showcase' in the QImPrESS_Showcase directory. This will 
build each separate application of the Showcase, create corresponding 
databases and populate them with test data, deploy all applications on 
the Tomcat server and open Showcase index page in your browser. From this 
page you can navigate to the individual applications and view their 
JavaDocs pages.



3. SHOWCASE DIRECTORY LAYOUT
----------------------------

The Showcase comprises several application projects each of them residing 
in a separate directory. An exemplary layout of each application project
is shown below.

- <application>
  |- db                   -> Database Definition Scripts
  |- dev                  -> Main Development Directory
     |- <application>_BE  -> Backend Development Directory
        |- classes        -> Compiled Classes
        |- db             -> Master (and Test) Data for the Database
        |- dist           -> Distribution Directory (for jar-Files)
        |- src            -> Sources
        |- test_src       -> Test Sources
     |- <application>_FE  -> Frontend Development Directory
        |- dist           -> Distribution Directory (for war-Files)
        |- src            -> Sources
        |- src_ws         -> Sources for Webservices (SOAP)
        |- src_rest_ws    -> Webservices for Mobile CRM Application (JSON)
        |- test_src       -> Test Sources
        |- WebContent     -> Web-app context root dir
     |- webdev-server     -> Configuration Files for development Tomcat servers
  |- dist                 -> Distribution Directory (for ZIP packages)
  |- docs                 -> Documentation
  |- install              -> Installation Templates (Scripts and Description)
  |- tools                -> Configurations for Development Tools