3.4. Unpacking the JRaceman Source

If you want to build JRaceman yourself, or just look at the source code, you will have to unpack the source files from the src.zip archive file with the commands

cd jraceman-N_N_N;
unzip src.zip

This will create a src directory with all of the Java files, as well as adding a few other files (such as a build.xml file) to your jraceman directory. You must have the ant program installed on your system in order to build JRaceman from source files. After unpacking, run "ant" to build the main jar file.

To build the war file for web use, run "ant war." This will create the file jraceman.war, which you can then copy into your web container's webapp directory.

Run "ant -p" to get a list of all of the build targets you can use.

If you want to look at the Javadoc-generated API documentation for the Java classes, you must first unpack those html files from the apidoc.zip archive file with the commands

cd jraceman-N_N_N;
unzip apidoc.zip

This will create the directory doc/api with all of the API documentation in it. Alternatively, you can unpack src.zip and then run the command

make doc

to run javadoc and create the API documents from the source files.

The JRaceman kit does not include the source to the Mckoi database. You can download the Mckoi database source from the Mckoi web site, or from the same location from which you downloaded JRaceman. You do not need the Mckoi source to compile JRaceman; the mckoidb.jar file included in the JRaceman kit is sufficient.

The JRaceman kit does not include the source to the jRegistryKey package. You can download the jRegistryKey source from the jRegistryKey web site, or from the same location from which you downloaded JRaceman. You do not need the jRegistryKey source to compile JRaceman; the jRegisgtryKey.jar file included in the JRaceman kit is sufficient.

The JRaceman kit does not include the source to the JShortcut package. You can download the JShortcut source from the JShortcut web site, or from the same location from which you downloaded JRaceman. You do not need the JShortcut source to compile JRaceman; the JShortcut.jar file included in the JRaceman kit is sufficient.

The JRaceman kit does not include the source to the JXL Excel spreadsheet reader. You can download the JXL source from the JXL web site, or from the same location from which you downloaded JRaceman. You do not need the JXL source to compile JRaceman; the jxl.jar file included in the JRaceman kit is sufficient.

The JRaceman kit does not include the source to JSF, the servlet or jsp APIs, or the commons file upload package, all of which are used in the web registration interface.