Modern Backbone Starter-kit

This project provides a prepared development environment for modern backbone development. ES6, Jest, HMR, css-next, eslint; all ready for you to use.

Getting Started

Just clone or fork the repo and start hacking:

$ git clone https://github.com/sabarasaba/modern-backbone-starterkit.git AwesomeApp && cd $_
$ yarn install
$ cp .env.example .env

Development

Uses webpack-dev-server with HMR to serve your app:

$ yarn dev

Note on css

This project uses postcss with a few plugins in order to provide a modern approach to dealing with css. It runs autoprefixer by default, supports nested classes, imports and everything else that css-next has to offer.

Production build

This will build a minified version of the app and will output everything into the public/ folder:

$ yarn build

If you wanna serve the production app you can do so by running:

$ yarn start

How to run tests

You can easily run the unit tests by doing:

$ yarn test

Or check your code coverage with:

$ yarn coverage

Linter

Currently using airbnb's presets, you can run it with:

$ yarn lint

How to Update

You can always fetch and merge the recent changes from this repo back into your own project:

$ git checkout master
$ git fetch upstream
$ git merge upstream/master
$ npm install

A Note on ES Classes

ES2015 Classes do not work well with Backbone or Marionette at time of writing. See https://github.com/jashkenas/backbone/issues/3560. Use Backbone's built in extend functions to get around this for the time being.

Learn More

• jQuery
• Lodash
• Handlebars
• Backbone.js
• Marionette.js
• Jest
• Webpack
• Babel
• css-next
• eslint

Support

Have feedback, feature request or need help? Create an issue !

License

The MIT License (MIT)

Copyright (c) 2017 Ignacio Rivas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.