Getting Started - adampresley/cfpowertools GitHub Wiki

Installation and Prerequisites

Before you begin there are a few prerequisites necessary to install so you can compile and use CF PowerTools.

Minimum requirements:

  • Java 6 JDK
  • Ant
  • CF PowerTools ZIP or code repository

Optional (if you wish to run the samples and build docs)

  • Tomcat 7
  • NaturalDocs
  • Perl
  • Python

Setting Up

If you wish to simply get started using CF PowerTools then download the ZIP file, open up the dist folder and copy all JAR files into your classpath. Classpath will vary depending up CF engine in use. This list will hopefully help you identify where to put the JAR files.

  • Adobe ColdFusion Standalone - {CF Install Path}/lib
  • Adobe ColdFusion (using JRUN) - {JRun Install Path}/servers/{instance}/cfusion.ear/cfusion.war/WEB-INF/cfusion/lib
    • {instance} refers to the name of a ColdFusion instance in an Enterprise install. You may have one or more instances
  • Railo - {site root}/WEB-INF/lib
  • OpenBD - {site root}/WEB-INF/lib

Restart your server (JRun, CF services, or your Java Servlet container) and the power of CF PowerTools is at your disposal.

Building the Source

To build the source you will need the minimum requirements from above installed and configured. Once Ant and its requirements are installed you can build the source from the command line like so.

$ ant buildJar

Executing this will create the necessary JAR files in the dist folder. The section above talks about how to take these files and put them into your server installation for use.

Building the Docs

If you also wish to build the docs you will need NaturalDocs installed. NaturalDocs is a documentation tool written in Perl that works across multiple languages. Unfortunately, at the time of this writing NaturalDocs does not have immediate support for Groovy, the language CF PowerTools is written in. I have provided a Python script that will setup all that is needed. This script currently only works in Linux for now (tested in Ubuntu 11.10 and 12.04).

To start run the installer script. Once all the necessary dependencies are installed you can have Ant build everything.

$ sudo ./install.sh
$ ant

Running the Examples

To run the examples you have a few options. The first is to copy the code, without the WEB-INF folder, into your Adobe ColdFusion site root and browse to your URL. The second is to place all the contents of the examples folder into a Java Servlet container's (like Tomcat or Glassfish) web app directory and browse to whatever context you placed it into.

Or, it you are running Ubuntu, and happen to have used the installation script above, you will have a new local Tomcat setup for this project, ready to go. On a command prompt simply execute:

$ ./start.sh

Once that is done loading browse to http://localhost:8080 in your browser.