Nutritious Pumpkin Masses

    okaylib

    0.5.6 • Public • Published

    ok

    Extensible MVC library

    Installing

    Clone repo

    Clone with git:

    $ git clone https://github.com/j-/ok.git

    Server

    Use npm to install:

    $ npm install --save okaylib

    Client

    The ok client library depends on underscore.

    Use bower to install:

    bower install --save okaylib

    Or include the JS file:

    <script src="https://cdn.rawgit.com/j-/ok/0.5.6/ok.js"></script>

    Using

    Server

    Load the module:

    var ok = require('okaylib');

    AMD

    Using an AMD library like require.js:

    require(['okaylib'], function (ok) {
     
    });

    Or you may be able to use the CommonJS style:

    define(function (require) {
        var ok = require('okaylib');
    });

    Global

    If AMD and CommonJS detection fails, ok will expose two globals, ok and okaylib. If there is a naming conflict you can call ok.noConflict() to restore the ok global to its value before ok was loaded.

    Documentation

    ok is documented with jsdoc style comments for generating docs.

    Installing jsdoc

    Install the jsdoc binary with npm:

    $ npm install --global jsdoc

    Generating docs

    In the ok/ directory:

    $ jsdoc .

    Documentation will be generated in ok/out/.

    License

    MIT license.

    Install

    npm i okaylib

    DownloadsWeekly Downloads

    3

    Version

    0.5.6

    License

    MIT

    Last publish

    Collaborators

    • j-