generator-bbb

BBB Generator

The Backbone-Boilerplate generator working on top of Yeoman.

A generator is a tool that allow you to rapidly create files, modules and automatically setup relationship between them. For example, the BBB generator can scaffhold a complete project structure. It can also create basic modules files and automatically link them to related unit test files. A generator will help you being more productive and automize repetitive scaffholding tasks.

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? (bbb:app)

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 and advanced use (bbb:init)

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

Create module (bbb:app)

Run yo bbb:module <name> to create a single module and its related test.

If needed, you can specify a sub-directory too: yo bbb:module views/list-item

Advanced configurations

For advanced use, you can customize the paths where you hold your application. For this, just run yo bbb:init command, and then manually edit the generated .bbb-rc.json configs. Some options in this file are not configured via the command line tool (for the sake of brievety). Once the manual edit is done, just run yo bbb to scaffhold the project.

Please note that changing paths manually in the .bbb-rc.json file won't update every config path in the multiple third party tools (e.g. Grunt, Bower, Jam). You'll need to fix these manually for now - full built-in support should come sometime in the future.

Developpement

Installation

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

# First, clone 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 local 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