generator-vertebrae
v0.1.0
Published
Yeoman generator for Backbone and RequireJS
Downloads
4
Maintainers
Readme
Vertebrae Generator
Yeoman generator based around Backbone and RequireJS. (Based on Backbone-Vertebrae by spember)
Yeoman generator that scaffolds out a front-end web app.
Technologies
I've incorporated the following technologies into the structure which I consider extremely useful for structuring and driving your front end application:
- Backbone: Thus the title. Brings decently coherent structure to your app
- Underscore: Required for Backbone; adds some nice convenience methods
- jQuery (optional): Ever-prevalent JS library
- Zepto (optional): I generally prefer it over jQuery
- Handlebars: My favorite JS templating engine; has a nice balance between feature set and being light-weight
- RequireJS: Asynchronous module management for your front end code. Really can't say enough good things about it. Once you understand how it works, you'll be writing highly modular, easily testable code in no time.
- Sass: Helps to manage your CSS
- Bootstrap (optional): Heavy-weight CSS and JS framework for starting up a responsive, feature-heavy app
- Font Awesome (optional): Bring font-based icons to your project
- Fastclick (optional): Brief JS library for eliminating the 300ms delay when clicking on mobile browsers
Additionally, for development/deployment purposes Vertabrae also includes:
- NodeJS: The only way to run your server-side JS. Required by several build tools (e.g. Grunt)
- Grunt: Fantastic JS-based Task Runner. Used to drive just about everything: tests, handlebars
- Karma: Used to be called 'Testacular'. A JS Test runner that can execute your tests in multiple browsers simultaneously, or go headless via PhantomJS and run in the background
- Jasmine: BDD JS testing
- Bower: Package Manager; use to download libraries rather than check into source code
The overall goal of encouraging the usage of a task runner like Grunt is to reinforce and encourage practices from the server-side world to your front end code.
Getting Started
Yeoman
- Install:
npm install -g yo
Vertebrae Generator
- Install:
npm install -g generator-vertebrae
- Run:
yo vertebrae
License
MIT