/generator-bbb

Yeoman generator for Backbone-Boilerplate - (work in progress)

Primary LanguageJavaScriptMIT LicenseMIT

BBB Generator Build Status

The Backbone-Boilerplate generator working on top of Yeoman.

Project stage: This is early alpha functionnalities. The generator is not yet published on NPM, it's only usable if installed manually.

Installation

  • Make sure you have yo installed: npm install -g yo
  • Install the generator: npm install generator-bbb (This generator is not yet on NPM)

Starting from Scratch?

Run yo bbb to start the default scaffholding

You can also assign a path option if you don't want to initialize BBB in the current working directory; e.g. yo bbb subfolder/myapp (note: the path can also be absolute)

Include in an existing project

Run yo bbb:init to initialize the generator configuration. This will allow you to use the generator on an existing project.

Create module

Run yo bbb:module to create a module.

Developpement

Installation

In order to work with the developpement version, you'll need to use npm-link functionnality.

# First, get the project from Github
cd install/dir
git clone repo/generator-bbb.git .

# Then install the dependencies manually
npm install

# Here you create a global link to `generator-bbb` which will be use by NPM
# This will allow you to use the module from NPM
npm link

# Then... use it!
cd dir/to/use/as/target
npm install generator-bbb
yo bbb # or any BBB generator options

License

MIT License