GithubHelp home page GithubHelp logo

gaearon / backbone.localstorage Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jeromegn/backbone.localstorage

1.0 2.0 1.0 639 KB

A localStorage adapter for Backbone.js

Home Page: http://documentup.com/jeromegn/backbone.localStorage

JavaScript 98.23% CSS 1.77%

backbone.localstorage's Introduction

Backbone localStorage Adapter v1.1.7

Build Status

Quite simply a localStorage adapter for Backbone. It's a drop-in replacement for Backbone.Sync() to handle saving to a localStorage database.

Gittip

Usage

Include Backbone.localStorage after having included Backbone.js:

<script type="text/javascript" src="backbone.js"></script>
<script type="text/javascript" src="backbone.localStorage.js"></script>

Create your collections like so:

window.SomeCollection = Backbone.Collection.extend({
  
  localStorage: new Backbone.LocalStorage("SomeCollection"), // Unique name within your app.
  
  // ... everything else is normal.
  
});

RequireJS

Include RequireJS:

<script type="text/javascript" src="lib/require.js"></script>

RequireJS config:

require.config({
    paths: {
        jquery: "lib/jquery",
        underscore: "lib/underscore",
        backbone: "lib/backbone",
        localstorage: "lib/backbone.localStorage"
    }
});

Define your collection as a module:

define("SomeCollection", ["localstorage"], function() {
    var SomeCollection = Backbone.Collection.extend({
        localStorage: new Backbone.LocalStorage("SomeCollection") // Unique name within your app.
    });
  
    return SomeCollection;
});

Require your collection:

require(["SomeCollection"], function(SomeCollection) {
  // ready to use SomeCollection
});

CommonJS

If you're using browserify.

Install using npm install backbone.localstorage, and require the module.

Backbone.LocalStorage = require("backbone.localstorage");

##Support

If you're having a problem with using the project, get help at CodersClan.

Contributing

You'll need node and to npm install before being able to run the minification script.

  1. Fork;
  2. Write code, with tests;
  3. make test or open spec/runner.html;
  4. Create a pull request.

Have fun!

Acknowledgments

License

Licensed under MIT license

Copyright (c) 2010 Jerome Gravel-Niquet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

backbone.localstorage's People

Contributors

4vanger avatar andreypopp avatar basicallydan avatar dremora avatar dwt avatar dy avatar eastridge avatar fluxusfrequency avatar igoralekseev avatar jeromegn avatar joemcelroy avatar juhovh avatar kmiyashiro avatar marcelklehr avatar marlun78 avatar nekman avatar paulmillr avatar rbu avatar renfredxh avatar rsskga avatar ryan-roemer avatar ryangreenberg avatar schickling avatar seancodes avatar snappedtogrid avatar spiralman avatar ssorallen avatar toddbranch avatar uzikilon avatar villadora avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

rubythonode

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.