bikini

Bikini

Everything a model needs.

What is Bikini

Bikini lets you treat being offline as a status. Not as an error.

You're developing a webapp for mobile browsers? You're damn right here!

With Bikini the user won't even notice that he is offline. It also improves the user experience by decreasing response latency.

Another cool feature of Bikini is that it keeps your app in sync. This allows you to build high collaborative apps by using socket.io.

Bikini is build on top of Backbone.js which gives your web application structure.

You should also have a lot at the introducing blog-post about Bikini.

How to use

Using Bikini is like taking candy from a baby.

cd into your project

install bikini via bower, this will handle all dependencies for you and lets you easily update the library.

bower install -S bikini

add the libraries to your .html file

<script src="bower_components/jquery/jquery.js"></script>
<script src="bower_components/underscore/underscore.js"></script>
<script src="bower_components/socket.io-client/socket.io.js"></script>
<script src="bower_components/backbone/backbone.js"></script>
<script src="bower_components/bikini/bikini.js"></script>

now, let's set up the magic

first, we need to define our Model and the according Collection

// Configure the Model
// Attribute key to identify the data
var MyBikiniServiceModel = Bikini.Model.extend({
    idAttribute: '_id'
});

// Tell the collection the endpoint url and which model it should use.
// The entity is used for retrieving local stored data
var MyBikiniServiceCollection = Bikini.Collection.extend({
    model: MyBikiniServiceModel,
    entity: 'myBikiniService',
    url: 'http://nerds.mway.io:8200/bikini/contacts',
});

To fetch data, you can simply call the Backbonejs function fetch()

var myCollection = new MyBikiniServiceCollection();
myBikiniServiceCollection.fetch();

You can listen to all the common Backbonejs events such as sync.

myCollection.on('sync', function() {
    console.log(arguments);
});

Event reference

See backbonejs-events for detailed information.

Using Bikini with AngularJS

You are building your application with AngularJS? No problem. We provide a thin wrapper between Bikini and AngularJS. All you need to do is to insert "bikangular.js".

<script src="bower_components/jquery/dist/jquery.js"></script>
<script src="bower_components/angular/angular.js"></script>
<script src="bower_components/underscore/underscore.js"></script>
<script src="bower_components/socket.io-client/socket.io.js"></script>
<script src="bower_components/backbone/backbone.js"></script>
<script src="bower_components/bikini/dist/bikini.js"></script>
<script src="bower_components/bikini/dist/bikangular.js"></script>

The reason for this wrapper is that if you are using AngularJS you are usally familiar with Kris Kowal's Q-Promises. But since Bikini relies on Backbone, and Backbone uses jQuery to make requests, we get jQuery-Promises if we make any requests. Also, AngularJS will not notice if any changes happend (2-way-binding).

We were able to fix that by using Angulars $http to perform requests.

Contributing

Get the Code

git clone [e-mail]:mwaylabs/bikini.git
cd bikini

Initialize Project

The script basicly checks if node is installed. Then npm install and bower install is called followed by setup of git hooks.

./init-repo.sh

Test if it works

run the test command

npm test

Update Version

Update Versionnumber

First of all update the version number in package.json and bower.json.

Generate build

After changing sourcecode you have to update the build version of bikini. The production folder is called dist and contains 4 autogenerated files. To generate them run

grunt dist

This will generate a dist/bikini.js and an minified version of it as well an AngularJS wrapper called dist/bikangular.js and also an minified version of it. grunt dist will also update the wiki github pages.

Publish

Generate a git tag for the current version number (bower update)

git tag -a vX.X.X -m vX.X.X
git push vX.X.X

then update the npm package

npm publish