History

mohamed-ahmed c54fb80f2e progress on changing 'user join' event		2013-11-12 22:21:11 +00:00
..
assets/css	HTML5: remove all old css files and adjust what's left	2013-11-01 17:25:00 -02:00
images	Add bbb-html5-client to labs not as submodule	2012-09-07 15:02:21 -04:00
lib	progress on changing 'user join' event	2013-11-12 22:21:11 +00:00
public	Public chat style updates	2013-11-01 13:47:53 -04:00
routes	HTML5: removing lots of unused or unnecessary code from the server	2013-10-30 10:08:16 -02:00
test	HTML5: Setting up the test environment for the node.js server	2013-10-30 10:08:15 -02:00
views	HTML5: pushing layout changes from @tylercopeland	2013-10-31 21:58:18 -02:00
.gitignore	HTML5: setting up docco for documentation	2013-10-30 10:08:14 -02:00
app.coffee	HTML5: use less instead of plain css	2013-10-31 12:50:52 -02:00
app.js	HTML5: basic conversion of the server to coffeescript	2013-10-30 10:06:58 -02:00
Cakefile	HTML5: Setting up the test environment for the node.js server	2013-10-30 10:08:15 -02:00
config.coffee	HTML5: cleanup and fix errors when a new user joins the session	2013-10-31 12:04:24 -02:00
package.json	HTML5: use less instead of plain css	2013-10-31 12:50:52 -02:00
README.md	HTML5: setting up a logger class	2013-10-30 10:08:15 -02: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