Awesome, you want to contribute back some code to JavaScriptMVC, or build your own download. This article explains how.

JavaScriptMVC is comprised of several projects, each with it's own repository:

• http://github.com/jupiterjs/steal
• http://github.com/jupiterjs/jquerymx
• http://github.com/jupiterjs/documentjs
• http://github.com/jupiterjs/funcunit

These are collected in the javascriptmvc repository:

• http://github.com/jupiterjs/javascriptmvc

Read how to get, test, and build each project in JavaScriptMVC:

1. Get

In Github, fork the repo you want to make changes to. Then clone the javascriptmvc repo and install the submodules like:

git clone git@github.com:jupiterjs/javascriptmvc

Now, open the javascriptmvc folder's .gitmodule file and change the url of the submodule(s) you have forked. For example, you might change:

    url = git://github.com/jupiterjs/jquerymx.git

to

    url = git://github.com/justinbmeyer/jquerymx.git

Now run:

cd javascriptmvc
git submodule init
git submodule update

Finally, you might need cd into each submodule and run

git checkout

Now make your changes!

2. Test

To test FuncUnit, Steal, and jQueryMX combined open javascriptmvc/test.html in every supported browser and run:

./js test/run.js

To test just the invidual projects, do the following:

StealJS

Open /steal/test/qunit.html in a browser.

Run:

./js steal/test/run.js

FuncUnit

Open /funcunit/funcunit.html and /funcunit/qunit.html in every browser.

Run:

funcunit/envjs funcunit/funcunit.html

jQueryMX

Open /jquery/qunit.html in every browser.

Run:

./js jquery/test/run.js

3. Build

Coming soon, but most projects have a build.js and so does framework.

4. Building the Docs

Run:

js jmvc\scripts\doc.js

If you have problems, you might need to create a jmvc/docs folder. Pages like this one are found in jmvc/pages/.

4. Deploying the Docs

Run:

ruby scripts\deploy.rb

First you need to add our EC2 private key in the scripts folder, named key. If you want to deploy, talk to Brian to get access to this key.