Using generator-brisket is the fastest way to get started.
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 && npm start
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.
Brisket Concepts And High Level Systems
- Modeling Data: How to fetch data in Brisket applications.
- Application Links: How to link from one route to another in a Brisket app.
- 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.
- Navigating with Brisket: Brisket provides methods to navigate the app in the browser.
- Testing with Brisket: Brisket provides tools to use in your test suite.
- Brisket.App: Initialize your application with Brisket.App.
- Brisket.createServer: A function that returns an express engine that you can use in your application to run the server.
- Brisket.Router: An implementation of Backbone.Router that routes on client and server.
- Brisket.Events: A proxy to Backbone.Events that exposes a noop on the server to avoid server-side memory leaks.
- 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.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.version: The version of Brisket. On the client, the version can be accessed by
- Brisket.onError: Registers error callback.
Using Brisket in your project
Install the Brisket into your project:
npm install brisket --save
Bundling your Brisket application
Check the Bundling With Browserify Recipe!
Compatibility and Requirements
Please refer to package.json for Brisket's dependencies
Brisket officially supports Node.js
>=4.0.0 i.e. it is tested in the latest versions of Node. However Brisket likely works with Node
0.12.0, and io.js
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:
To support IE7, include the snippet above AND the following:
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. When the SPA functionality is disabled, Brisket will operate like a standard website i.e. clicking application links will cause a page reload.
$ npm install
To run the test suite:
$ npm test
To run benchmarks:
$ npm run benchmarks
jsdom error with Legacy Node.js and io.js
For Node.js 0.10.x, 0.11.x and 0.12.x, specify the version of jsdom to be v3.x,
rm -rf ./node_modules/brisket/node_modules/jsdom npm install jsdom@3 --save
For io.js, specify the version of jsdom to be v6.x,
rm -rf ./node_modules/brisket/node_modules/jsdom npm install jsdom@6 --save
Apache License (Version 2). See license text in LICENSE.