README.md

GoAngular is an open source integration of GoInstant with AngularJS. GoAngular is officially supported by GoInstant.

Build realtime, collaborative applications quickly and easily.

You can learn more in our tutorial, and documentation or by looking under the hood of this todo example.

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

Packaging

For your convenience, we've packaged GoAngular 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 GoAngular in your build process.

Bower

We've packaged GoAngular as a bower component.

bower install goangular

Contributing

Development Dependencies

• node.js >= 0.8.0
• gulp installed globally
  • $ npm install -g gulp

Set-Up

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

git clone https://github.com/goinstant/goangular.git
cd goangular
npm install

Building GoAngular for Development

GoAngular is built using browserify.

For convenience, we've included a number of simple gulp commands:

default task: $ gulp
Removes build & dist directories
Browserify lib & index.js to build directory as build.js
Start LiveReload & watch directories, re-build on change
Serve static assets via. Harp & open /example/index.html on port 5000 in Chrome

develop task: $ gulp develop
Removes build & dist directories
Browserify lib & index.js to build directory as build.js

test task: $ gulp test
Start Karma test-runner, you'll need PhantomJS

If this command runs successfully you'll now have a build directory in your Git repo root.

Running Example

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

You should have run $ gulp develop or $ gulp 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/index.html