Brisket

About Brisket

Brisket is a framework for building single page web apps using isomorphic JavaScript. A Brisket app is both a traditional web site AND a single page web application at the same time. Brisket provides the tools that you need to spend your time focusing on your application's logic rather than on "what environment is my code running in?".

Getting Started

Using generator-brisket is the fastest way to get started.

Install Yeoman:

npm install -g yo

To install generator-brisket from npm, run:

npm install -g generator-brisket

Create a directory for your app:

mkdir projectname
cd projectname

Finally, initiate the generator and run your app:

yo brisket && grunt

Your first brisket app will be available at http://localhost:8080

Getting More Started

Now that you have a working app, check out our Recipes for common use cases.

Documentation

Brisket's Parts

Brisket.createServer: A function that returns an express engine that you can use in your application to run the server.
Brisket.Routers: A helper object to help you initialize Backbone Routers.
Brisket.ServerApp: An application that will do the necessary wiring on the server. Inherit to add your own functionality.
Brisket.ClientApp: An application that will do the necessary wiring on the client. Inherit to add your own functionality.
Brisket.RouterBrewery: Brews routers that know how to route on the server and the client. Allows you to make your own RouterBrewery.
Brisket.Controller: A helper object to move functionality off of the router (it doesn't provide any functionality; just semantics).
Brisket.Model: Our version of a Backbone.Model that knows how to sync on the server and the client.
Brisket.Collection: Our version of a Backbone.Collection that knows how to sync on the server and the client.
Brisket.View: Our version of a Backbone.View that allows support for some of the core features - reattaching views, child view management, memory management, etc.
Brisket.Layout: A specialized View that handles meta tags, page title, etc.
Brisket.Layout.Metatags: Use this class to make metatags for "pages".
Brisket.Templating.TemplateAdapter: Inherit from this to tell Brisket how to render templates.
Brisket.Templating.StringTemplateAdapter: The default template adapter. Set a View's template key to be a string template to get started.
Brisket.ErrorViewMapping: Creates errorViewMappings for your routers (e.g. 404 should show Page Not Found).
Brisket.version: The version of Brisket. On the client, the version can be accessed by window.Brisket.version after the ClientApp has started.
Brisket.onError: Registers error callback.

Brisket Concepts And High Level Systems

Application Links: How to link from one route to another in a Brisket app.
Brisket Router vs Backbone.Router: What makes a Brisket Router different from a regular Backbone.Router.
Brisket Request Object: The Brisket request object normalizes access to important data about the current request.
Brisket Response Object: The Brisket response object normalizes modifying the current response.
Child Views: Brisket provides a system to help you manage a View's child views.

Using Brisket in your project

Install the Brisket into your project:

npm install brisket --save

While Brisket does not force you to use any particular bundling library, you will be responsible for bundling your application for browser consumption. For now, you will have to ignore Brisket's server components and shim jQuery Mockjax since it is not CommonJS compliant. Here is an example config using grunt-browserify@1.3.2:

browserify: {
    options: {
        alias: [
            'node_modules/brisket/node_modules/jquery/dist/jquery.js:jquery'
        ],
        ignore: [
            'node_modules/brisket/lib/server/*'
        ],
        shim: {
            'jquery-mockjax': {
                path: 'node_modules/brisket/vendor/javascripts/jquery.mockjax.js',
                exports: null,
                depends: { jquery: 'jQuery' }
            }
        }
    }

}

Note that jQuery is aliased in this case because it is a dependency of jQuery Mockjax.

Compatibility and Requirements

Brisket also depends on the following libraries:

jQuery ~1.11.1
jsdom ~0.11.1
Underscore ~1.6.0
Backbone ~1.1.2
bluebird ~2.2.1
jquery-mockjax ~1.5.3
express ~4.0.0
qs 1.2.2

Browser Support

Chrome, Firefox, Safari, iOS 6+, Android 4+, Internet Explorer 9+

For support in older versions of IE you can include your favorite shim libraries in the head of your layout. For example to support IE8 include the following in your head tag:

<!--[if lt IE 9]>
    <script type='text/javascript' src='//cdnjs.cloudflare.com/ajax/libs/es5-shim/2.3.0/es5-shim.min.js'></script>
    <script type='text/javascript' src='//cdnjs.cloudflare.com/ajax/libs/es5-shim/2.3.0/es5-sham.min.js'></script>
<![endif]-->

To support IE7, include the snippet above AND the following:

<!--[if lt IE 8]>
    <script type='text/javascript' src='http://cdnjs.cloudflare.com/ajax/libs/json3/3.3.1/json3.min.js'></script>
<![endif]-->

Note: In IEs < 10, the single page app functionality that Brisket provides will not work since pushState is not available. Brisket does not support hash tag SPA's (TODO: link this to a page describing why not). When the SPA functionality is disabled, Brisket will operate like a standard website i.e. clicking application links will cause a page reload.

Development

Make sure you have grunt-cli installed globally. To install:

$ npm install -g grunt-cli

Install dependencies:

$ npm install

To run the test suite:

$ grunt

License

Apache License (Version 2). See license text in LICENSE.

Copyrights and Names

Brisket is copyrighted by Bloomberg Finance LP. Brisket is a service mark of Bloomberg LP.

kyasui / brisket