This section will help you to get started using ZOO-Client.
- 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 )
Node.js is also required on your system for compiling ZOO-Client templates.
If you did not download the ZOO-Project source code already, please proceed to a svn checkout with the following command:
svn checkout http://svn.zoo-project.org/svn/trunk/zoo-project/zoo-client
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
/zoo-project/zoo-client/lib/tpl directory downloaded from
Install Node.js (see related documentation.)
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
Using different versions of Hogan to compile and to use in a web application may lead to compatibility issue.
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
your working directory.
Building the ZOO-Client API documentation is optional, please refer to the up-to-date ZOO-Client API Documentation for the current API version.