Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yeoman/generator-backbone
Scaffold out a Backbone.js project
https://github.com/yeoman/generator-backbone
Last synced: 3 months ago
JSON representation
Scaffold out a Backbone.js project
- Host: GitHub
- URL: https://github.com/yeoman/generator-backbone
- Owner: yeoman
- Archived: true
- Created: 2012-11-21T22:38:43.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2017-02-13T17:35:09.000Z (about 8 years ago)
- Last Synced: 2024-08-03T02:08:49.648Z (7 months ago)
- Language: JavaScript
- Homepage: http://yeoman.io
- Size: 588 KB
- Stars: 638
- Watchers: 44
- Forks: 157
- Open Issues: 21
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
Awesome Lists containing this project
- awesome-projects-boilerplates - Yeoman Backbone Generator
- awesome - generator-backbone
README
# Backbone.js generator [](http://travis-ci.org/yeoman/generator-backbone) [](https://coveralls.io/r/yeoman/generator-backbone?branch=master)
A Backbone generator for Yeoman that provides a functional boilerplate Backbone app out of the box. You also get access to a number of sub-generators which can be used to easily create individual models, views, collections and so on.
Optional RequireJS (AMD) support has recently been added as a prompt when using the generator on new projects.
## Usage
Install: `npm install -g generator-backbone`
Make a new directory and `cd` into it:
```
mkdir my-new-project && cd $_
```
Run `yo backbone`, optionally passing an app name:
```
yo backbone [app-name]
```
## Generators
Available generators:
- backbone:model
- backbone:view
- backbone:collection
- backbone:router
- backbone:all
## Typical workflow
```
yo backbone # generates your application base and build workflow
yo backbone:model blog
yo backbone:collection blog
yo backbone:router blog
yo backbone:view blog
grunt serve
```
Also checkout this [NetTuts write-up](http://net.tutsplus.com/tutorials/javascript-ajax/building-apps-with-the-yeoman-workflow/) for a guide to building Backbone.js apps using this generator.
## Options
* `--appPath`
Generate scaffold into a custom directory.
* `--coffee`
Generate scaffolds in CoffeeScript. By default check if project uses CoffeeScript.
* `--requirejs`
Generate scaffolds using RequireJS (AMD) Loader. By default check if project uses RequireJS.
* `--skip-install`
Skips the automatic execution of `bower` and `npm` after
scaffolding has finished.
* `--test-framework=[framework]`
Defaults to `mocha`. Can be switched for
another supported testing framework like `jasmine`.
* `--template-framework=[framework]`
Defaults to `lodash` templating with grunt-contrib-jst.
`handlebars` and `mustache` are also supported.
## A note regarding JST templates and strict mode
If you use strict mode in your app and JST templates the default grunt-jst implementation will cause your app to error out as the templates will be precompiled using a 'with' statement.
This can be addressed by changing the jst grunt task as follows:
```
jst: {
compile: {
options:
{
templateSettings:
{
variable: 'data'
}
},
files: {
'.tmp/scripts/templates.js': ['<%= yeoman.app %>/scripts/templates/*.ejs']
}
}
},
```
A result of this change is that your template variable definitions must also be updated from `<%= templateVariable %>` to `<%= data.templateVariable %>`. More information on this can be found in the [Underscore documentation](http://underscorejs.org/#template).
## Contribute
See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)
When submitting an issue, please follow the [guidelines](https://github.com/yeoman/yeoman/blob/master/contributing.md#issue-submission). Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
When submitting a new feature, add tests that cover the feature.
## License
[BSD license](http://opensource.org/licenses/bsd-license.php)