goinstant / collaboration-bundle

. This repo will no longer be updated. GoInstant will be discontinued as of August 31, 2014. Read our blog for more details.

Collaboration Bundle

The Collaboration Bundle collects the GoInstant widgets together, providing an easy-to-use, drop-in collaboration layer in any web site.

You can learn more in our guides, and documentation.

Have questions? We're on IRC. #goinstant on Freenode.

Packaging

For your convenience, we've packaged the Collaboration Bundle in several ways.

Using our CDN

We host a copy on our CDN. Have a look at the docs to see how to reference those files, as well as how to initialize the component.

How do I build the script myself?

You may have your own build process. We've tried to make it easy to include the Collaboration Bundle in your build process.

Bower

We've packaged the Collaboration Bundle as a bower component.

bower install collaboration-bundle

Component

We've packaged the Collaboration Bundle as a component.

component install collaboration-bundle

Contributing

Development Dependencies

• node.js >= 0.8.0
• grunt-cli installed globally
  • npm install -g grunt-cli

Set-Up

The following assumes that you have already installed the dependencies above.

git clone https://github.com/goinstant/collaboration-bundle.git
cd collaboration-bundle
npm install

Building Collaboration Bundle for Development

The Collaboration Bundle is built as a component. Feel free to manually install dependencies and build using the component command line tool.

For convenience, we've included a simple grunt command for installing component dependencies and building:

grunt build

If this command runs succesfully you'll now have components and build directories in your Git repo root.

Running Tests

Tests are written in mocha. They're run in an HTML file.

Just open the test/index.html file to run the tests.

On Mac OS, you can just run this command to open the HTML Runner in your default browser:

open test/index.html

Running Example

This will open up an example of Collaboration Bundle at work, using your local build.

You should have run grunt build already.

1. Copy the example config.

cp config/config.example.js config/config.js

2. Replace the connectUrl with your Platform application's.

If you haven't signed up for GoInstant yet, you can sign up and create an application here.

After you have an application's connectUrl, put it inside of config.js:

config.js

window.CONFIG = {
  connectUrl: 'https://goinstant.net/YOUR_ACCOUNT/YOUR_APP'
};

3. Open the example

open examples/example.html