Yeoman generator for AngularJS + Firebase (and AngularFire) - lets you quickly set up a project with sensible defaults and best practices.
Install generator-angularfire:
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
Note: Generators are to be run from the root directory of your app.
Sets up a new AngularJS + Firebase app, generating all the boilerplate you need to get started. The app generator also optionally installs Firebase authentication and account management, Bootstrap and additional AngularJS modules, such as angular-resource (installed by default).
Example:
yo angularfireGenerates a controller and view, and configures a route in app/scripts/app.js connecting them.
Example:
yo angularfire:route myrouteProduces app/scripts/controllers/myroute.js:
angular.module('myMod').controller('MyrouteCtrl', function ($scope) {
// ...
});Produces app/views/myroute.html:
<p>This is the myroute view</p>Explicitly provide route URI
Example:
yo angularfire:route myRoute --uri=my/routeProduces controller and view as above and adds a route to app/scripts/app.js
with URI my/route
Generates a controller in app/scripts/controllers.
Example:
yo angularfire:controller userProduces app/scripts/controllers/user.js:
angular.module('myMod').controller('UserCtrl', function ($scope) {
// ...
});Generates a directive in app/scripts/directives.
Example:
yo angularfire:directive myDirectiveProduces app/scripts/directives/myDirective.js:
angular.module('myMod').directive('myDirective', function () {
return {
template: '<div></div>',
restrict: 'E',
link: function postLink(scope, element, attrs) {
element.text('this is the myDirective directive');
}
};
});Generates a filter in app/scripts/filters.
Example:
yo angularfire:filter myFilterProduces app/scripts/filters/myFilter.js:
angular.module('myMod').filter('myFilter', function () {
return function (input) {
return 'myFilter filter:' + input;
};
});Generates an HTML view file in app/views.
Example:
yo angularfire:view userProduces app/views/user.html:
<p>This is the user view</p>Generates an AngularJS service.
Example:
yo angularfire:service myServiceProduces app/scripts/services/myService.js:
angular.module('myMod').service('myService', function () {
// ...
});You can also do yo angularfire:factory, yo angularfire:provider, yo angularfire:value, and yo angularfire:constant for other types of services.
Generates an AngularJS service decorator.
Example:
yo angularfire:decorator serviceNameProduces app/scripts/decorators/serviceNameDecorator.js:
angular.module('myMod').config(function ($provide) {
$provide.decorator('serviceName', function ($delegate) {
// ...
return $delegate;
});
});In general, these options can be applied to any generator, though they only affect generators that produce scripts.
For generators that output scripts, the --coffee option will output CoffeeScript instead of JavaScript.
For example:
yo angularfire:controller user --coffeeProduces app/scripts/controller/user.coffee:
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 --coffee=false.
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.
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:
yo angularfire:service serviceName --skip-addThe following packages are always installed by the app generator:
- angular
- angular-mocks
- angular-scenario
- firebase
The following additional modules are available as components on bower, and installable via bower install:
- 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.
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:
{
"name": "yo-test",
"version": "0.0.0",
...
"appPath": "public"
}
This will cause Yeoman-generated client-side files to be placed in public.
Note that you can also achieve the same results by adding an --appPath option when starting generator:
yo angularfire [app-name] --appPath=publicRunning grunt test will run the unit tests with karma.
Recent changes can be viewed on Github on the Releases Page