Using ZOO-Client¶

This section will help you to get started using ZOO-Client.

Prerequisites¶

ZOO-Client is based on the following Javascript libraries

jQuery (http://www.jquery.com)
x2js (https://code.google.com/p/x2js)
Require.js (http://requirejs.org )
Hogan.js (http://twitter.github.io/hogan.js )
query-string (https://github.com/sindresorhus/query-string )

Warning

Node.js is also required on your system for compiling ZOO-Client templates.

Download¶

If you did not download the ZOO-Project source code already, please proceed to a svn checkout with the following command:

svn checkout https://github.com/ZOO-Project/ZOO-Project/trunk/zoo-project/zoo-client

Warning

You do not necessarily need to install the ZOO-Project server for using ZOO-Client. The corresponding svn directory is needed only.

Compiling ZOO-Client templates¶

In order to work with ZOO-Client, you will first need to compile the provided Mustache templates using Node.js. The ZOO-Client templates are located in the /zoo-project/zoo-client/lib/tpl directory downloaded from svn.

Install Node.js (see related documentation.)
Install Hogan, the JavaScript templating engine, using the following command:
```
sudo npm install hogan
```
Use Hulk (Hogan’s command line utility) for compiling the tempaltes using the following command:
```
hulk zoo-client/lib/tpl/*mustache > \ zoo-client/lib/js/wps-client/payloads.js
```

Warning

Using different versions of Hogan to compile and to use in a web application may lead to compatibility issue.

Everything is now ready to work with ZOO-Client. Read the next section for an example JavaScript application.

Building ZOO-Client API documentation¶

You may also build the ZOO-Client API documentation using jsDoc, with the following command:

npm install jsdoc
~/node_modules/.bin/jsdoc zoo-client/lib/js/wps-client/* -p

This will build HTML documentation in a new directory named /out in your working directory.

Note

Building the ZOO-Client API documentation is optional, please refer to the up-to-date ZOO-Client API Documentation for the current API version.