History

Richard Alam 473c9941b4 - handle validate token message from node app		2014-05-11 12:30:58 -07:00
..
assets/css	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
images	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
lib	- handle validate token message from node app	2014-05-11 12:30:58 -07:00
log	Add missing log/ dir in the HTML5 client	2014-04-24 17:41:28 -04:00
public	Get the token from the URL to authenticate the HTML5 client	2014-04-25 10:34:26 -04:00
routes	HTML5 client authentication using redis and the new messages	2014-04-24 17:39:59 -04:00
test	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
test-tools	Get the token from the URL to authenticate the HTML5 client	2014-04-25 10:34:26 -04:00
views	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
.gitignore	Add missing log/ dir in the HTML5 client	2014-04-24 17:41:28 -04:00
app.coffee	Using classes for the new files and structure in the html5 server	2014-04-23 16:18:25 -04:00
app.js	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
Cakefile	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
config.coffee	- change how we subscribe to redis messages	2014-05-08 21:32:09 +00:00
generate_fake_events.txt	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
iotest.coffee	- don't use classes	2014-04-13 17:16:37 -07:00
package.json	- trying to setup message handlers	2014-04-13 16:39:18 -07:00
README.md	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00

README.md

BBB-HTML5-Client

Development

Setting up the environment

1. Install Node.js

Here's a quick how-to for installing it from source code (replace X.X.X by the required node version that you can find on package.json):

wget http://nodejs.org/dist/vX.X.X/node-vX.X.X.tar.gz
tar -xvf node-vX.X.X.tar.gz
cd node-vX.X.X/
./configure
make
sudo make install

2. Install node dependencies

cd bbb-html5-client
npm install

3. Clean Redis database

redis-cli flushdb

4. Do a clean restart of BigBlueButton

bbb-conf --clean

5. Run the BBB server

cd bbb-html5-client
node app.js

Generating the documentation

This application uses codo to generate HTML pages with the documentation for the HTML5 client and server. This documentation is targeted for developers.

To generate the documentation pages, use:

cake docs

The files will be output to the folder docs/.

Testing

Run:

cake test

To run tests for a single file:

cake -f test/lib/modules-test.coffee test

To stop immediately in case a test fails:

cake -b test