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:
Using
Server
Load the module:
var ok = ;
AMD
Using an AMD library like require.js:
;
Or you may be able to use the CommonJS style:
;
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/
.