AppFuseQuickStart

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

1. Install J2SE 1.4.2+ and set a JAVA_HOME environment variable pointing to your installation directory.
2. Download the source version or checkout the appfuse module from CVS (cvs -d :pserver:[email protected]:/cvs co appfuse).
   NOTE: You can download AppFuse 1.8, Ant 1.6.2, Tomcat 5.0.28 and MySQL 4.1.11 (for Windows) using the all-in-one installer. View this package's README.txt for more information.
3. Install Ant 1.6.2+ and set an ANT_HOME environment variable. Install Tomcat 4.1.x+ (recommend 5.0.28) and set a CATALINA_HOME environment variable to point to your Tomcat installation. Checkout my development environment setup to get links for these packages and to see where I usually install them.
4. Install MySQL 3.23.x+ (recommend 4.1.7).
   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.
5. Setup a local SMTP server 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.
6. Copy lib/junit3.8.1/junit.jar to $ANT_HOME/lib.
   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.
7. If you're planning on using iBATIS (instead of Hibernate) or a web framework other than Struts, install that now using the instructions below.
8. 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.
   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.
9. 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?
10. 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.

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

Optional Installations

• If you'd like to use iBATIS as a persistence framework option, view the README.txt in extras/ibatis or run ant install-ibatis.
• If you'd like to use Spring as the web framework, view the README.txt in extras/spring or run ant install-springmvc.
• If you'd like to use WebWork as the web framework, view the README.txt in extras/webwork or run ant install-webwork.
• If you'd like to use JSF as the web framework, view the README.txt in extras/jsf or run ant install-jsf.
• If you'd like to use Tapestry as the web framework, view the README.txt in extras/tapestry or run ant install-tapestry.

• 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 and webwork. 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.