README.md

KORM

Knockout ORM framework with REST service adapter and offline storage.

Installation

Using Bower:

$ bower install korm --save

Using NuGet:

$ Install-Package KORM

Usage

You could use korm in different context.

Browser (AMD from source)

Configure RequireJS.

requirejs.config({
    paths: {
        knockout: 'path/to/knockout',
        underscore: 'path/to/underscore',
        jquery: 'path/to/jquery',
        koutils: 'path/to/koutils',
        korm: 'path/to/korm'
    }
});

Load modules

define(["korm/datacontext"], function(context) {
    var ctx = new context.DataContext();
    ctx.addSet("Customers", "CustomerId", "Models.Customer");
    //...
});

Browser (with built file)

Include built script in your HTML file.

<script type="text/javascript" src="path/to/knockout.js"></script>
<script type="text/javascript" src="path/to/underscore.js"></script>
<script type="text/javascript" src="path/to/jquery.min.js"></script>
<script type="text/javascript" src="path/to/koutils.min.js"></script>
<script type="text/javascript" src="path/to/korm.min.js"></script>

Documentation

Documentation is hosted on Github Wiki.