Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tbranyen/backbone-boilerplate

A workflow for building Backbone applications.
https://github.com/tbranyen/backbone-boilerplate

Last synced: about 1 month ago
JSON representation

A workflow for building Backbone applications.

Awesome Lists containing this project

README 

        
![Boilerplate](https://github.com/tbranyen/backbone-boilerplate/raw/assets/header.png)



[![Build status][travis-image]][travis-url] 

[![Code coverage][coveralls-image]][coveralls-url] 

[![Gitter][gitter-image]][gitter-url]



Backbone Boilerplate

====================



This boilerplate is the product of much research and frustration.  Existing

boilerplates freely modify Backbone core, lack a build process, and are very

prescriptive; Backbone Boilerplate changes that.



The Backbone Boilerplate is a way of organizing a web application with some

opinionated defaults, such as: [Backbone](http://backbonejs.org),

[jQuery](http://jquery.com), [Lodash](http://lodash.com),

[Grunt](http://gruntjs.com), [Babel](https://babeljs.io/),

[Combyne](https://github.com/tbranyen/combyne),

[Karma](http://karma-runner.github.io/0.12/index.html),

[Mocha](https://mochajs.org), and [PureCSS](http://purecss.io/) for styles.



Organize your application with a logical file structure, develop your

Models/Collections/Views/Routers inside modules, and build knowing you have

efficient code that will not bottleneck your users.



Thanks to our

[Contributors](https://github.com/tbranyen/backbone-boilerplate/contributors)!

Special Thanks to: [cowboy](http://github.com/cowboy),

[iros](http://github.com/iros), [nimbupani](http://github.com/nimbupani),

[wookiehangover](http://github.com/wookiehangover), and

[jugglinmike](http://github.com/jugglinmike) for helping me create this

project.  Extra Special Thanks to: [Paul

Guinan](http://bigredhair.com/work/paul.html) for giving me usage rights to his

fantastic Boilerplate character.



## Documentation ##



[Backbone Boilerplate Wiki](https://github.com/tbranyen/backbone-boilerplate/wiki)



## Getting started ##



The easiest way to get started is to install Git and clone the repository:



``` bash

# Using Git, fetch only the latest commits.  You won't need the full history

# for your project.

git clone --depth 1 https://github.com/tbranyen/backbone-boilerplate



# Move the repository to your own project name.

mv backbone-boilerplate my-project

```



You will need to download and install [Node](http://nodejs.org/) to fetch the

dependencies and use the build tools.



## Updating dependencies ##



Third party packages may update independently from this main repo, so it's a

good idea to update after fetching.



``` bash

npm install

```



## Build process ##



The build process consists of numerous Grunt plugin tasks that work together

to optimize your application.



``` bash

# To run the build process, run the NPM start script. This will automatically

# run JSHint, the development Connect server, and watch your files for changes.

npm start



# Run a build and test the now optimized assets.

npm run test-prod

```



## Working with tests ##



Create an ES6 module in the `test/tests` directory and add an

import in the `test/runner.js` file. You'll see existing examples in there to

make it easy to follow.



Run the tests with:



``` bash

npm test

```



If you want to continuously test, run `npm start` and open the

`test/index.html` file in your browser. The tests will re-run whenever you

change source files.



By default, the test runner is BDD Mocha and uses Node's assert.



## License ##

Copyright © 2015 Tim Branyen (@tbranyen)  

Licensed under the MIT license.



[travis-url]: http://travis-ci.org/tbranyen/backbone-boilerplate

[travis-image]: https://img.shields.io/travis/tbranyen/backbone-boilerplate.svg

[coveralls-url]: https://coveralls.io/r/tbranyen/backbone-boilerplate

[coveralls-image]: https://img.shields.io/coveralls/tbranyen/backbone-boilerplate.svg

[gitter-url]: https://gitter.im/tbranyen/backbone-boilerplate

[gitter-image]: https://img.shields.io/badge/GITTER-join%20chat-green.svg