Raible's Wiki: AppFuseQuickStart

At line 1 added 2 lines.

<div style="border: 1px solid #F0C000; background-color: #FFFFCE; padding: 10px">__NOTE:__ This wiki and its contents are for AppFuse 1.x. If you'd like to use AppFuse 2.x, please see the [new wiki|http://appfuse.org] or the [AppFuse 2.x QuickStart Guide|http://appfuse.org/display/APF/AppFuse+QuickStart].</div>

At line 2 removed 9 lines.

# Download the source version or CVS version.

# 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.

# 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.

# Setup a local SMTP server or change mail.properties (in the root) to point to an existing one - it defaults to ''localhost''.

# Copy lib/junit3.8.1/junit.jar to $ANT_HOME/lib.

# Run "ant new -Dapp.name=YOURAPPNAME -Ddb.name=YOURDBNAME". This will create a directory named YOURAPPNAME in the same directory as appfuse.

# 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.

# Run "ant test-reports" - there will be a message after it runs telling you how you can view the generated reports.

At line 12 changed 2 lines.

''If you'd like to use [iBATIS|http://ibatis.com] as a persistence framework option, view the README.txt in {{contrib/ibatis}}.''

----

# Install J2SE 1.4.2+ and set a JAVA_HOME environment variable pointing to your installation directory.

# [Download|https://appfuse.dev.java.net/servlets/ProjectDocumentList] the source version or checkout the 1.9.x branch from Subversion (svn co https://appfuse.dev.java.net/svn/appfuse/branches/BRANCH_1-9-x appfuse).

# Install Ant 1.6.5+ and set an ANT_HOME environment variable. Install Tomcat 4.1.x+ (recommend 5.5.20) and set a CATALINA_HOME environment variable to point to your Tomcat installation. Checkout my [development environment setup|DevelopmentEnvironment] to get links for these packages and to see where I usually install them.

# Install MySQL 3.23.x+ (recommend 5.0+). <div class="note" style="margin: 10px"> __NOTE:__ If you're using MySQL 4.1.7, make sure to use a UTF-8 character set and an InnoDB table type. [Here's how|http://raibledesigns.com/wiki/Wiki.jsp?page=AppFuseSupport#ref-AppFuseSupport-5].</div>

# [Setup a local SMTP server|AppFuseSMTP] or change mail.properties (in the web/WEB-INF/classes directory) and build.properties (in the root -- for log4j messages) to point to an existing one - they default to ''localhost''.

# Copy lib/junit3.8.1/junit.jar to $ANT_HOME/lib.<div class="note" style="margin: 10px">__NOTE:__ You may see an ant-junit.jar file already in $ANT_HOME/lib. This jar is not the JUnit library, rather it is for the Ant junit task which will use the junit.jar that you place here.</div>

# If you're planning on using iBATIS (instead of Hibernate) or a web framework other than Struts, install that now using the instructions below.

# Run __ant new__ from the appfuse directory. You will be prompted for an application name, database name and package name. After entering these, a directory containing your new application will be created in the same directory as appfuse. <div class="note" style="margin: 10px; background-color: #fcc"> __WARNING:__ Some application values will not work - don't use "test", anything with "appfuse" in it or anything that starts with numbers. Also, two dashes (-) in a name will mess things up.</div>

# Navigate to your new project's directory and run __ant setup__ (or __ant setup-db setup-tomcat deploy__) to create the database, configure Tomcat and deploy your application. The database setup will only work if your root user has no password. You can change this in build.properties if necessary. Need [assistance with mysql setup|assistance with ant setup]?

# If you want to test and make sure everything works, run __ant test-all__ - make sure Tomcat is stopped when you do this. Next, run __ant test-reports__ - there will be a message after it runs telling you how you can view the generated reports.

At line 15 changed 1 line.

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.

After you've confirmed your installation using the above steps - take a look at the [Tutorials|Articles] to see how to develop with AppFuse.

At line 17 changed 1 line.

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:

__Optional Installations__

At line 19 changed 7 lines.

{{{- 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}}}

<div class="note" style="margin-left: 40px"> __NOTE:__ If you're developing with AppFuse on Unix, run "ant fixcrlf" before running the installers. You can also download a pre-built version that already has the web framework option you're looking for.</div>

At line 27 changed 1 line.

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".

* If you'd like to use [iBATIS|http://ibatis.com] as a persistence framework option, view the README.txt in {{extras/ibatis}}.

* If you'd like to use [Spring|http://www.springframework.org/docs/reference/mvc.html] as the web framework, view the README.txt in {{extras/spring}}.

* If you'd like to use [WebWork|http://www.opensymphony.com/webwork] as the web framework, view the README.txt in {{extras/webwork}}.

* If you'd like to use [JSF|http://myfaces.apache.org/] as the web framework, view the README.txt in {{extras/jsf}}.

* If you'd like to use [Tapestry|http://jakarta.apache.org/tapestry] as the web framework, view the README.txt in {{extras/tapestry}}.

At line 29 changed 1 line.

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:

* If you'd like you can write a script to automate the creation and testing of your project from AppFuse. There are a couple in CVS that I use for testing: [spring+ibatis|https://appfuse.dev.java.net/source/browse/*checkout*/appfuse/Attic/test-spring.sh?content-type=text/plain] and [webwork|https://appfuse.dev.java.net/nonav/source/browse/*checkout*/appfuse/Attic/test-webwork.sh?content-type=text/plain]. Note that using "appfuse" in a real-world project name is a bad idea as it'll find/replace things it shouldn't.

* If you don't want to install iBATIS, Spring MVC, WebWork, JSF or Tapestry - you should delete their installers in the {{extras}} folder before checking your project into source control.

At line 31 changed 3 lines.

{{{- compile-service - change org/appfuse to com/company

- junitdoclet-module - change org.* to com.*

- javadoc - change org.* to com.*}}}

<div class="note" style="margin-left: 40px"> __NOTE:__ These installers will modify the Eclipse classpath, but not the IDEA one. You'll need to modify that manually.</div>

Raible's Wiki

AppFuse

Other Applications

AppFuseQuickStart