History

Anton Georgiev 6952184799 handles a bug where empty users are added to the array		2014-03-31 15:45:32 +00: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	handles a bug where empty users are added to the array	2014-03-31 15:45:32 +00:00
public	user_joined_event: when received, the user is added to the list of users	2014-03-31 15:43:34 +00:00
routes	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
test	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
views	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
.gitignore	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
app.coffee	- move the html5 client out of labs	2014-01-06 08:44:15 -08: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	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
generate_fake_events.txt	- move the html5 client out of labs	2014-01-06 08:44:15 -08:00
package.json	integrated whiteboard_draw/update_event	2014-02-20 22:48:46 +00: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