https://github.com/iamdtang/backbone-data

A simple data store for backbone models and collections inspired by Ember Data and angular-data.
https://github.com/iamdtang/backbone-data

Last synced: about 4 hours ago
JSON representation

A simple data store for backbone models and collections inspired by Ember Data and angular-data.

• Host: GitHub
• URL: https://github.com/iamdtang/backbone-data
• Owner: iamdtang
• Created: 2014-11-16T22:47:03.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-13T02:48:07.000Z (over 9 years ago)
• Last Synced: 2024-10-03T10:48:11.287Z (about 7 hours ago)
• Language: JavaScript
• Homepage:
• Size: 363 KB
• Stars: 17
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Backbone Data

=============

[![Build Status](https://travis-ci.org/skaterdav85/backbone-data.svg)](https://travis-ci.org/skaterdav85/backbone-data)

A simple data store for Backbone models and collections inspired by Ember Data and angular-data.

## Key Features

* Automatic Caching and Identity Mapping

	* If a model had already been loaded, asking for it a second time will not make any network requests. This minimizes the number of round-trips to the server.

* Provides a single point of entry for data access through the global variable _DS_ and works with existing Backbone models and collections.

* Manages singletons for models and collections 

	* Many times you'll need the same collection instance in multiple views. Just ask the store for the resource (`DS.getAll('person')`, `DS.findAll('person')`) and it will return or resolve with the same collection instance each time.

	* Maybe you have a single model instance in your application, like a `UserProfile` model. The data store can also manage it as a singleton so that you get the same `UserProfile` instance every time.

* Load models into the store as incomplete. This can be useful if your models have lots of data and not all of it is served upfront. Extra details about the model can be fetched and cached for subsequent requests.

* Easily create new filtered collections that are chainable

* AMD compatible

* 933 bytes gzipped and minified

[API Documentation and Examples](apidocs.md)

## Install

Grab the minified or unminified file from the _dist_ directory and include it on your page.

```html

```

Or install through Bower

```

bower install backbone-data

```

Or install through NPM

```

npm install backbone-data

```

This library exposes a global variable called _DS_ (Data Store) and it is also registers itself for AMD (Require.js).

## Tests

Tests are using Mocha, Chai, and Sinon. Run tests with karma.

```js

bower install

npm install

karma start

```

## Build

This will create the distribution files in the _dist_ folder

```

gulp

```