#g5-knockout.js

Knockout/Browserify base app - MVVM with an event layer.

g5-knockout is an app/module scaffold based on a tried and proven

application architecture and solid development patterns.

Read More

View Demo App

---

---

###Setup

Install the package and use it as a scaffold for your app or module.

npm install g5-knockout

###Server

Server running on http://localhost:9966 with auto builds, [Ctrl+C] to kill server

npm run start-dev

###Test

npm test

###Build

npm run build

###Module Usage

let demoApp = g5Knockout({
    container: document.getElementById('g5-knockout-app'),
    interval: 10000,
    path: '/src/data/demo-app.json',
    enablePolling: true
});

demoApp.init();

###Options

• container: Element unique element to bind Knockout to
• interval: Number refresh rate (milliseconds)
• i18n: String localization identification (en/es)
• path: String path to data file
• enablePolling: Boolean

###Methods

####init()

instantiates viewModel, model, and applies bindings to main container

demoApp.init();
demoApp.init(); // single instance allowed, second call to method is ignored

####display(isVisible)

toggles visibility of main container

demoApp.display(false); // main container is hidden
demoApp.display(true);  // main container is visible

####off()

detaches all events

demoApp.off();

####on()

attaches all events

demoApp.on();

####destroy()

removes container element and destroys instance

demoApp.destroy();

###Style Guide / Rules

• Style Guide - https://github.com/airbnb/javascript
• Protect against new - constructors can be called with or without new
• Maintain chainability, methods return this

###Notes

• npm run start will run a single build and start the server, if you want auto builds run npm run start-dev
• If you're having issues running the setup command, make sure you have the proper permissions setup (you can also attempt to run the commands with sudo, although that is usually discouraged)

###TODO

• Add additional templating engines (i.e. doT - http://jsperf.com/knockout-template-engines/25)
• Additional methods on core
• Additional documentation and directions
• Implement Git hooks and JSCS (airbnb style validation)
• Build/Test Badge - Integrate Testling
• Add babelify / update to ES6
• Simple KO components implementation
• Upgrade to Knockout 3.3 / etc...
• allow single instance of EventTower
• Cleanup
• Additional tests
• Additional docs
• Live demo
• Add destroy method to core module
• Refactor model
• Refactor viewModel - keep observables under one data Object for a cleaner reference
• Refactor EventTower
• Medium writeup
• Fix server / watchify instance
• Register package

###Reference

• About g5-knockout
• KnockoutJS Docs
• Browserify Handbook
• Task Automation with npm run
• About Watchify
• Tape Tests
• Simple HTTP Server
• JSDoc

###License

Copyright (c) 2015, Greg Babula [email protected]

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.