Yeoman generator for CanJS
Maintainer: Scott Markley
Based on Generator-Angular
First make a new directory, and
cd into it:
mkdir my-new-project && cd $_
npm install generator-can generator-karma
yo can, optionally passing an app name:
yo can [app-name]
Finally, install npm and bower dependencies:
npm install && bower install --dev
Sets up a new CanJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Twitter Bootstrap as well as testing suite Qunit.
Generates a controller and view, and configures a route in
app/scripts/app.js connecting them.
Generates a controller in
yo can:controller user
Generates an HTML view file in
yo can:view user
This is the user view
There are options for each of the methods for registering services. For more on using these services, see the CanJs AMD documentation.
In general, these options can be applied to any generator, though they only affect generators that produce scripts.
For generators that output scripts, the
yo can:controller user --coffee
The following packages are always installed by the app generator:
The following additional modules are available as components on bower, and installable via
All of these can be updated with
bower update as new versions of CanJS are released.
Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.
You can change the
app directory by adding a
appPath property to
component.json. For instance, if you wanted to easily integrate with Express.js, you could add the following:
This will cause Yeoman-generated client-side files to be placed in
For tests to work properly, karma needs the
can-mocks bower package.
This script is included in the component.json in the
devDependencies section, which will
be available very soon, probably with the next minor release of bower.
devDependencies are not yet implemented, you can fix it by running:
bower install can-mocks
grunt test you should now be able to run your unit tests with karma.
See the contributing docs
When submitting an issue, please follow the guidelines. 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.
node --debug-brk $(which grunt) task
Use node-inspector &