Building and Deploying WebWorks Samples

We now have 5 samples at WebWorks-Samples (TunnelTilt, is a sixth one but it is at WebGL-Samples):

Aura, Payment and SketchPad were designed specifically for the PlayBook.  I believe KitchenSink and UIExamples started for the smartphones but they work equally well on the PlayBook, although the layout of UIExamples is better in portrait rather than landscape mode.


The instructions are the same for all the samples.  They are similar to those for TunnelTilt, except that you don’t need to bundle any extra WebWorks extensions.

The usual setup for debug mode – see Install the Developers Beta and Install a Debug Token.  Set your PlayBook in Development Mode, and write down the DEVICEIP and the DEVICEPASS.


Download the samples from GitHub.  Pay some attention to the branch you are using – you want master because gh-pages is missing sketchpad (issue #18).

You can download via a git clone, or just a plain zip download.

If you choose a ZIP, GitHub will create a ZIP file for you that corresponds to the state of the repository right now.  Something like  Unzip it and, if you want, rename the directory to something like blackberry-WebWorks-Samples.

The result will look something like:

bash-3.2$ /bin/ls -1 -p blackberry-WebWorks-Samples/

We will now build and deploy each sample.  All samples are built and deployed using the same instructions.

Build and Deploy

Each sample directory has the HTML, CSS, JS and other resource files needed (locally) by the application.  Each sample also has a widget configuration file config.xml that describes what features will be needed by the application, the icon to use on the home screen, the name, the description, and other resources.

You just need 3 commands per sample: zip your WebWorks application, then package that ZIP into a BAR, then deploy. The zip command is most likely bundled in your platform, the packager comes from the WebWorks SDK, the deployer is also included in the WebWorks SDK although that is a copy of that in the NDK.

bash-3.2$ which zip
bash-3.2$ which bbwp
bash-3.2$ which blackberry-deploy

If you wonder about that wwsdk directory, it is really a symlink to the standard installation directory to give it a sensible name:

bash-3.2$ ls -l /Developer/SDKs/wwsdk-
lrwxr-xr-x  1 root  wheel  64 Dec 28 17:40 /Developer/SDKs/wwsdk- -> Research In Motion/BlackBerry WebWorks SDK for TabletOS

And that’s pretty much all. If we save the ZIPs and BARs in the top directory for simplicity, the commands for each application are of the form:

bash-3.2$ cd Aura
bash-3.2$ zip -r ../ *
bash-3.2$ bbwp ../ -d -v -o ..
bash-3.2$ blackberry-deploy -installApp \
-password DEVICEPASS -device DEVICEIP \
-package ../
bash-3.2$ cd ..

At the end you will have 5 new applications in your PlayBook:


About pelegri

VP, Technology at Progress Software
This entry was posted in HTML5 and tagged , . Bookmark the permalink.

2 Responses to Building and Deploying WebWorks Samples

  1. New @ BB says:

    Well this guide sucks big time!!!!! Know your audience!!!!!!!

    • pelegri says:

      So tell me more about what folks like you need here. “Sucks big time” is not an actionable description.

      I was working on a companion post using on Ripple but there were some issues in the version available during the Xmas break and I decided to wait; and I’m still waiting for a moment to do it.

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )


Connecting to %s