archfirst / keel Goto Github PK

Write tests for framework/Router.js

Add image optimization grunt task.

Write documentation for framework/ExceptionUtil.js

The page naming convention needs to be updated to allow camelCasing of pageNames based on dashes in the url.

Need to validate that npm install works in Node latest.

While trying to install as instructed in readme.md, grunt throwing following error

Running "clean:clean" task
Warning: Cannot read property 'src' of undefined Use --force to continue.

Aborting due to warnings.

Any help appreciated...

Write documentation for framework/Message.js

When I click on the links listed below the "Home" section, it hits the server...

Build out WIKI

Write documentation for framework/MessageBus.js

Need to upgrade and test against BB1.0.

In theory, certain widgets (e.g. header/footer) could be long-running, living across multiple pages. The current buildout does not allow this.

Look into whether a long-running widget is a memory leak or a good thing. Best practices? Tradeoff?

I'd like this framework to work as well with multiple applications as it does with one. This will certainly involve some thinking and tradeoffs around Router, especially.

Update README.md for latest version of framework architecture.

Write tests for framework/Message.js (necessary?)

BaseView.addChild() has a parameter called parentElement. It's usage needs to be properly documented. One cannot blindly put parentElement: this.$el when calling addChild(). It is required only if we are creating a new DOM node and “placing” it under the parent. In situations where we are simply hanging a view off of existing markup, then parentElement should be left undefined, instead options.el should be defined.

So we have two patterns:

Creating new DOM nodes

postRender: function() {
    this.addChildren([
        {
            id: 'OutputPanel',
            viewClass: OutputPanel,
            parentElement: this.$el
        }
    ]);
}

Attaching views to existing DOM nodes

postRender: function() {
    this.addChildren([
        {
            id: 'Dashboard',
            viewClass: Dashboard,
            options: {
                el: this.dashboardElement
            }
        }
    ]);
}

Add Ruby and Compass to requirements - without this the build instructions will not work.

We could almost use Trader Desktop build instructions for this project - they are quite comprehensive. In fact, if we instruct people to run the app with Node, then many of the complications of setting appRoot can be avoided for the beginner.

Write documentation for framework/Router.js

On several occasions I find myself creating blank templates just to avoid Keel’s default of <div></div> - see Bullsfirst code for several examples. In fact, I don’t think there is a single instance where I have taken advantage of the default.

My suggestion is to test for the case of the template being undefined and in such a case, not ti do template substitutions. It will avoid creation of a whole slew of blank templates. Also I am finding that the views that do D3 visualizations are not template based – they are totally rendered in JavaScript. There is also the case where markup is completely defined in a parent template and I simply want to hang a view somewhere inside it.

Write tests for framework/ExceptionUtil.js