Skip to content

Documentation for Verse Javascript Developers

Jiri Hnidek edited this page Jan 9, 2015 · 3 revisions

To build verse-javascript library it is necessary to type following commands:

git clone [email protected]:verse/verse-javascript.git 
cd verse-javascript
npm install
bower install

When you want to hack the library, then it is wise to run Grunt:

grunt watch

Building Minificated Version of Verse Library

To build minificated version of library you have to type following command:

grunt requirejs

Previous command is necessary to run, when API of library was changed. It will build/update two files:

  • build/verse.amd.min.js
  • build/verse.standalone.min.js

Updated versions of these two files is also necessary to push to git repository.

Testing Comunication with Verse Server

To test communication with Verse server copy ./example/config.standalone.js to ./example/config.js and ./example/standalone.html to ./example/index.html. Modify these files:

// config.js
var config = {
    uri: 'ws://localhost:23456',
    version: 'v1.verse.tul.cz',
    username: 'your_username',
    passwd: 'your_password'
};
<!-- index.html -->
<script type="text/javascript" src="config.js"></script>

Finally open ./index.html in your favorite web browser.

Optionally you can copy ./example/app_standalone.js to ./example/app.js and try to do some experiments with verse.