Yeoman generator for AngularJS using RequireJS
Yeoman generator for AngularJS using RequireJS - lets you quickly set up a project with sensible defaults and best practices.
There are many starting points for building a new Angular single page app, in addition to this one. To see a comparison of the popular options, have a look at this comparison.
For step-by-step instructions on using Yeoman and generators to build a TODO AngularJS application from scratch see this tutorial.
npm install -g grunt-cli bower yo generator-karma-require generator-angular-require
Make a new directory, and
cd into it:
mkdir my-new-project && cd $_
yo angular-require, optionally passing an app name:
yo angular-require [app-name]
grunt build must be run before anything else due to dependency population in the RequireJS config and the like (this will be fixed in a future version).
grunt for building and
grunt serve for preview
Sets up a new AngularJS-RequireJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Bootstrap and additional AngularJS modules, such as angular-resource (installed by default). All files created will be in the RequireJS/AMD format, and therefore all will be within "define" blocks.
Generates a controller and view, and configures a route in
app/scripts/app.js connecting them.
yo angular-require:route myroute
define'angular''use strict';angularmodule'myApp.controllers.myrouteCtrl'controller'myrouteCtrl'// ...;;
This is the myroute view
Explicitly provide route URI
yo angular-require:route myRoute --uri=my/route
Produces controller and view as above and adds a route to
app/scripts/app.js with URI
Generates a controller in
yo angular-require:controller user
define'angular''use strict';angularmodule'myApp.controllers.userCtrl'controller'userCtrl'// ...;;
Generates a directive in
yo angular-require:directive myDirective
define'angular''use strict';angularmodule'myApp.directives.myDirective'directive'myDirective'returntemplate: '<div></div>'restrict: 'E'link:elementtext'this is the myDirective directive';;;;
Generates a filter in
yo angular-require:filter myFilter
define'angular''use strict';angularmodule'myApp.filters.myFilter'filter'myFilter'returnreturn 'myFilter filter:' + input;;;;
Generates an HTML view file in
yo angular-require:view user
This is the user view
Generates an AngularJS service.
yo angular-require:service myService
define'angular''use strict';angularmodule'myApp.services.myService'service'myService'// ...;;
You can also do
yo angular-require:value, and
yo angular-require:constant for other types of services.
Generates an AngularJS service decorator.
yo angular-require:decorator serviceName
define'angular''use strict';angularmodule'myApp.decorators.serviceName'config$providedecorator'serviceName'// ...return $delegate;;;;
In general, these options can be applied to any generator, though they only affect generators that produce scripts.
CoffeeScript is not supported at this time. Sorry. We'll take a look at CoffeeScript possibly being added at a later date.
tl;dr: You don't need to write annotated code as the build step will handle it for you.
By default, generators produce unannotated code. Without annotations, AngularJS's DI system will break when minified. Typically, these annotations that make minification safe are added automatically at build-time, after application files are concatenated, but before they are minified. The annotations are important because minified code will rename variables, making it impossible for AngularJS to infer module names based solely on function parameters.
The recommended build process uses
ng-annotate, a tool that automatically adds these annotations. However, if you'd rather not use it, you have to add these annotations manually yourself. Why would you do that though? If you find a bug in the annotated code, please file an issue at ng-annotate.
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 AngularJS are released.
As part of the
grunt build command, bower dependencies are inserted into the
bootstrap.js file using the
bower:app task specified in the Gruntfile. The
test-bootstrap.js file is taken care of by keeping it's dependencies in line with
bootstrap.js. This is handled by the
replace:test task within the Gruntfile.
es5-shim have been removed as Angular 1.3 has dropped IE8 support and that is the last version that needed these shims. If you still require these, you can include them with:
bower install --save json3 es5-shim.
wiredep should add them to your index.html file but if not you can manually add them.
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
bower.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
Note that you can also achieve the same results by adding an
--appPath option when starting generator:
yo angular-require [app-name] --appPath=public
grunt test will run the 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 PR, make sure that the commit messages match the AngularJS conventions.
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.
Recent changes can be viewed on Github on the Releases Page
Much <3 to the Yeoman community for creating such a great tool!
If you like generator-angular-require, please tell your friends and colleagues. If you are writing about or mentioning generator-angular-require, let me know and I will happily link to it from here.