Building

1. Build Configuration
2. Ant Targets
3. Framework Dependencies
4. Extras Dependencies

1.  Build Configuration

+--[build]                      Ant build directory
|   |
|   +---build.xml               Ant build script
|   |
|   +---build.properties        Ant build properties
|   
+--[dist]                       JAR and WAR file output directory
|
+--[documentation]              Click documentation set application
|
+--[examples]                   Click Examples application
|   |
|   +---build.xml               Ant build script
|   |  
|   +---README.txt              Click Examples Readme file
|
+--[extras]                     Click Extras source directory
|
+--[framework]                  Click framework source directory
|
+--[lib]                        Dependent JAR libraries directory
|
+--[mock]                       Mock objects source directory 

1.1  Build Requirements

1. Ensure JAVA_HOME environment variable is set and points to a JDK installation (1.4 or later).

2. Ensure ANT_HOME environment variable is set and points to an Ant installation (1.7.0 or later).

3. Ensure junit.jar is present in your ANT_HOME/lib directory.

2.  Ant Targets

ant help
Buildfile: build.xml

help:
     [echo] Click web application framework
     [echo] ===============================

     [echo] Main targets:

     [echo] build-all             build framework, extras, examples
     [echo] build-distribution    build distribution ZIP file
     [echo] build-examples        build click-examples WAR file
     [echo] build-extras          build click-extras JAR file
     [echo] build-framework       build click framework JAR file
     [echo] build-maven-bundles   build Maven repository upload bundles
     [echo] build-sources         build source ZIP files for use with IDEs
     [echo] deploy-examples       copy examples WAR files to app server
     [echo] get-deps              download JAR dependencies
     [echo] get-deps-proxy        download JAR dependencies via proxy
     [echo] help                  display the Help message
     [echo] javadoc               create Javadoc HTML files
     [echo] project-quick-start   build application template


     [echo] Please ensure you have configured build.properties


BUILD SUCCESSFUL 

2.1  Getting Dependencies

1. Run the Ant target get-deps to download JAR dependencies from Ibiblio Maven repository:

   ant get-deps 

   If you are behind a firewall use the Ant target get-deps-proxy and configure you proxy settings in build.properties

   # Proxy hostname used by Ant target 'get-deps-proxy'
   proxy.host=192.168.0.3
   
   # Proxy port for by Ant target 'get-deps-proxy'
   proxy.port=3128 

2.2  Building Framework

1. Ensure the above configurations have been made and get-deps has been run.

2. Run the Ant target build-framework to build the framework:

   ant build-framework 

2.3  Building Extras

1. Ensure the above configurations have been made and get-deps has been run.

2. Run the Ant targets framework and build-extras:

   ant build-framework build-extras 

2.4  Building Examples

1. Please see the examples/README.txt file, ensuring the required properties have been configured and the dependencies downloaded.

2. Ensure the above configurations have been made and get-deps has been run.

3. Run the Ant target build-all:

   ant build-all 

3.  Framework Dependencies

The standard click-xx.jar includes all of the listed dependencies.
Alternatively use the click-nodeps-xx.jar which includes none of these dependencies.

4.  Extras Dependencies

Please note: a runtime dependency is only required if you use the specific library. For example, if you use Hibernate, you need hibernate.jar on your classpath, otherwise it is not needed.