public
Description: Web Application Framework in JavaScript and Objective-J
Home | Edit | New

Getting and Building the Source

If you’d like to contribute to the Cappuccino project, or simply want to keep up with the latest and greatest additions, here are some instructions for building it on your own.

Requirements

There are a few required tools for getting and building Cappuccino. Chances are you though that you probably have many if not all of these installed on your system, especially if you are on a Mac and have already installed Xcode tools for instance.

  • Git is of course required for getting the source.
  • Rake 0.8.4 is used for building Cappuccino. There is a good chance that you already have Rake on your system, but it may not be version 0.8.4. To check, simply type the following into your command line:
$ rake —version

You should get something like the following:

$ rake, version 0.8.4

If it is less than 0.8.4, it is highly recommended that you upgrade. If it’s higher you will be fine.

  • gcc is used to for its preprocessor.
  • Doxygen is optional and is used for generating the documentation.

Getting the Source

Getting the source is easy:

$ git clone git://github.com/280north/cappuccino.git cappuccino

Building the Source

Before you can build Cappuccino you will need to set up one environment variable: $CAPP_BUILD. Normally, capp puts build products in their project directory, but Cappuccino expects all products to be in one place. Put the following in your .bash_login or .profile or wherever you like to place your environment variables:

$ export CAPP_BUILD=“/path/to/wherever/you/want/build/products/to/go”

Now you will want to install the tools and build Cappuccino. Simply perform the following:

$ cd path/to/cappuccino $ rake install

This may take a little while, since it is not only building Cappuccino itself, but all the Tools as well, and installing them incrementally. Once it is completed though, you should have all the latest tools installed as well as a freshly built copy of Cappuccino.

Following this initial build, when you make changes you will want to build using either the “release” or “debug” commands:

$ rake release $ rake debug

If you want to reinstall these though, you will have to once again run the “install” command. This is often not necessary since you can link your projects to the built version of the frameworks with the following command:

$ capp gen -l -f

Trying it Out

To see if everything worked, you can create a new Cappuccino test project linked to your built frameworks:

$ capp gen TestProject -l

Now run TestProject/index.html in your favorite browser and you should be all set to start hacking away on Cappuccino!
If you are using Firefox see Developing locally in Firefox for further instructions.

Last edited by chandlerkent, Wed Aug 19 09:02:59 -0700 2009
Home | Edit | New
Versions: