========================================
How to test and build Hippo Site Toolkit
========================================

1. Introduction

  Very brief introduction to how to build, test and run HST!

2. Requirements --

  (1) Java 1.5
  (2) Maven 2.0.9 or higher
  (3) [Optional] Tomcat 5.5 or 6.0 (if you want to deploy and run on Tomcat.)
      -- Note shared lib folder path, depending on your Tomcat version, in your build.properties.

3. Build
    
    (1) Build with testing
    
      $ mvn clean install
    
    (2) Build with skipping tests
    
      $ mvn clean install -DskipTests 
    
4. Running an example site

  (1) With Embedded Jetty

    - To run repository and cms, move to demosuite/cms folder and run the following:
      
      $ mvn jetty:run-war
    
    - To run site web application, move to demosuite/site folder and run the following:
      
      $ mvn jetty:run
  
    - Visit the page: http://127.0.0.1:8085/site/preview/
    
  (2) With Tomcat

    - Move to demosuite/site folder.
    - Copy build.properties-sample to build.properties in the folder.
    - Edit the tomcat directory path and shared lib folder path in build.properties.
      For example,
      
        tomcat.server.home = /home/jdoe/tomcat-6.0.18
        tomcat.hst.shared.lib = ${tomcat.server.home}/lib  # For tomcat 6.x. Use ${tomcat.server.home}/shared/lib for Tomcat 5.x.
      
    - Run the following to deploy applications in the folder.
  
      $ mvn -P tomcat clean install
  
    - Visit the preview pages by http://127.0.0.1:8080/site/preview/
    - Visit the live pages by by http://127.0.0.1:8080/site/
    - You can visit cms by http://127.0.0.1:8080/cms/
      and console by http://127.0.0.1:8080/cms/console/