Yeoman generator for Angular+Firebase
npm install generator-angularfire> Yeoman generator for AngularJS + Firebase (and AngularFire) - lets you quickly set up a project with sensible defaults and best practices.
For step-by-step instructions on using Yeoman and this generator to build a TODO AngularJS application from scratch see this tutorial.
Install yo, grunt, bower, generator-angularfire and generator-karma:
``
npm install -g generator-angularfire
Make a new directory, and cd into it:`
mkdir my-new-project && cd $_
Run yo angularfire, optionally passing an app name:`
yo angularfire [app-name]
Run grunt for building and grunt serve for preview
Available generators:
* angularfire (aka angularfire:app)
* angularfire:controller
* angularfire:directive
* angularfire:filter
* angularfire:route
* angularfire:service
* angularfire:provider
* angularfire:factory
* angularfire:value
* angularfire:constant
* angularfire:decorator
* angularfire:view
Example:
`bash`
yo angularfire
connecting them.Example:
`bash
yo angularfire:route myroute
`Produces
:
`javascript
angular.module('myMod').controller('MyrouteCtrl', function ($scope) {
// ...
});
`Produces
:
`html
This is the myroute view
`Explicitly provide route URI
Example:
bash
yo angularfire:route myRoute --uri=my/route
`Produces controller and view as above and adds a route to
with URI $3
Generates a controller in .Example:
`bash
yo angularfire:controller user
`Produces
:
`javascript
angular.module('myMod').controller('UserCtrl', function ($scope) {
// ...
});
`
$3
Generates a directive in .Example:
`bash
yo angularfire:directive myDirective
`Produces
:
`javascript
angular.module('myMod').directive('myDirective', function () {
return {
template: '',
restrict: 'E',
link: function postLink(scope, element, attrs) {
element.text('this is the myDirective directive');
}
};
});
`$3
Generates a filter in .Example:
`bash
yo angularfire:filter myFilter
`Produces
:
`javascript
angular.module('myMod').filter('myFilter', function () {
return function (input) {
return 'myFilter filter:' + input;
};
});
`$3
Generates an HTML view file in .Example:
`bash
yo angularfire:view user
`Produces
:
`html
This is the user view
`$3
Generates an AngularJS service.Example:
bash
yo angularfire:service myService
`Produces
:
`javascript
angular.module('myMod').service('myService', function () {
// ...
});
`You can also do
, yo angularfire:provider, yo angularfire:value, and yo angularfire:constant for other types of services.$3
Generates an AngularJS service decorator.Example:
`bash
yo angularfire:decorator serviceName
`Produces
:
`javascript
angular.module('myMod').config(function ($provide) {
$provide.decorator('serviceName', function ($delegate) {
// ...
return $delegate;
});
});
`Options
In general, these options can be applied to any generator, though they only affect generators that produce scripts.$3
For generators that output scripts, the option will output CoffeeScript instead of JavaScript.For example:
`bash
yo angularfire:controller user --coffee
`Produces
:
`coffeescript
angular.module('myMod')
.controller 'UserCtrl', ($scope) ->
`A project can mix CoffeScript and JavaScript files.
To output JavaScript files, even if CoffeeScript files exist (the default is to output CoffeeScript files if the generator finds any in the project), use
.$3
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.
$3
By default, new scripts are added to the index.html file. However, this may not always be suitable. Some use cases:* Manually added to the file
* Auto-added by a 3rd party plugin
* Using this generator as a subgenerator
To skip adding them to the index, pass in the skip-add argument:
`bash
yo angularfire:service serviceName --skip-add
`Bower Components
The following packages are always installed by the app generator:
* angular
* angular-mocks
* firebase
The following additional modules are available as components on bower, and installable via
:* angular-animate
* angular-aria
* angular-cookies
* angular-messages
* angular-resource
* angular-sanitize
All of these can be updated with
bower update as new versions of AngularJS or Firebase are released.json3 and 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.Configuration
Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.$3
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:`json
{
"name": "yo-test",
"version": "0.0.0",
...
"appPath": "public"
}`
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:
`bash
yo angularfire [app-name] --appPath=public
`Testing
Running
Recent changes can be viewed on Github on the Releases Page