AppFuseQuickStart

This is version 32. It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

1. Download the source version or CVS version.
2. Install J2EE 1.4, set a J2EE_HOME environment variable, install J2SE 1.4+, set a JAVA_HOME environment variable, install Ant 1.5.1-1.5.4, set an ANT_HOME environment variable.
3. Install MySQL 3.23.x+ and Tomcat 4.1.x+. Make sure Tomcat has mail.jar, activation.jar and jta.jar in its common/lib directory (copy from J2EE_HOME/lib if missing). Set a CATALINA_HOME environment variable to point to your Tomcat installation. You should use jakarta-tomcat-version to name the Tomcat directory.
4. Setup a local SMTP server or change mail.properties (in the root) to point to an existing one - it defaults to localhost.
5. Copy lib/junit3.8.1/junit.jar to $ANT_HOME/lib.
6. Run "ant new -Dapp.name=YOURAPPNAME -Ddb.name=YOURDBNAME". This will create a directory named YOURAPPNAME in the same directory as appfuse.
7. Navigate to the new directory and run "ant setup-db setup-tomcat deploy" to setup your app on Tomcat. If you want to test and make sure everything works, run "ant test-all" - make sure Tomcat is stopped when you do this.
8. Run "ant test-reports" - there will be a message after it runs telling you how you can view the generated reports.

If you'd like to use iBATIS as a persistence framework option, view the README.txt in contrib/ibatis.

Usually, after you get all this to work - it's likely you'll want to change all your package names to "com.company" rather than "org.appfuse". I use Eclipse to rename packages. To do this, go to the package view, click on a package name and right click -> Refactor -> Rename. Type in "*.xml,*.properties,*.xdt" for File name patterns to search in.

NOTE: If you want to use iBATIS, I recommend you install it (instructions at contrib/ibatis/README.txt) before renaming all the packages. If you don't install it first, you can add the ibatis/src as a source directory and rename packages there. Make sure to edit/change all the package names in the .xml files.

By adding "*.xml,*.properties,*.xdt" to the File name patterns field in the Rename Package wizard, the following files should be changed as well. If you're not using Eclipse or something isn't working right - you might want to ensure the "org.appfuse" has been changed to "com.company" in the following files:

- metadata/web/global-exceptions.xml
- web/WEB-INF/tiles-config.xml
- web/WEB-INF/classes/log4j.properties
- web/WEB-INF/validator-rules-custom.xml
- src/service/com/company/service/applicationContext-service.xml
- src/dao/com/company/persistence/hibernate/applicationContext-hibernate.xml
- metadata/templates/struts_form.xdt

You'll need to manually change the location of the Hibernate mapping files in the applicationContext-hibernate.xml file (location listed above). Basically, "org/appfuse" needs to be changed to "com/company".

You'll also need to change a few targets in build.xml to refer to the new package names. These targets/changes are listed below:

- compile-service - change org/appfuse to com/company
- junitdoclet-module - change org.* to com.*
- javadoc - change org.* to com.*