generator-angular-ui-router editorconfig travis-ci grunt npm

I add "ui-router" in this module. Fork from

AngularJS generator (add ui-router plugin)

This project fork from :yeoman / generator-angular I add ‘ui-router’ plugin in this module.

Maintainer: iamblue

Based on angular-seed

This project is one of many things that you can use to get started on a new app. For a comparison of the options and the trade-offs between them, please visit this link.


Install generator-angular-ui-router:

npm install -g generator-angular-ui-router

Make a new directory, and cd into it:

mkdir my-new-project && cd $_

Run yo angular-ui-router, optionally passing an app name:

yo angular-ui-router [app-name]

Optionally using Sass:

[?] Would you like to use Sass with the Compass CSS Authoring Framework? Yes
[?] Which syntax do you prefer? (Use arrow keys)
❯ sass 


Available generators:

Note: Generators are to be run from the root directory of your app.


Sets up a new AngularJS app, generating all the boilerplate you need to get started. The app generator also optionally installs Twitter Bootstrap and additional AngularJS modules, such as angular-resource.


yo angular-ui-router


Generates a controller and view, and configures a route in app/scripts/app.js connecting them.


yo angular-ui-router:route myroute

Produces app/scripts/controllers/myroute.js:

angular.module('myMod').controller('MyrouteCtrl', function ($scope) {
  // ...

Produces app/views/myroute.html:

<p>This is the myroute view</p>


Generates a controller in app/scripts/controllers.


yo angular-ui-router:controller user

Produces app/scripts/controllers/user.js:

angular.module('myMod').controller('UserCtrl', function ($scope) {
  // ...


Generates a directive in app/scripts/directives.


yo angular-ui-router:directive myDirective

Produces 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.


yo angular-ui-router:filter myFilter

Produces 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.


yo angular-ui-router:view user

Produces app/views/user.html:

<p>This is the user view</p>


Generates an AngularJS service.


yo angular-ui-router:service myService

Produces app/scripts/services/myService.js:

angular.module('myMod').service('myService', function () {
  // ...

You can also do yo angular-ui-router:factory, yo angular-ui-router:provider, yo angular-ui-router:value, and yo angular-ui-router:constant for other types of services.


Generates an AngularJS service decorator.


yo angular-ui-router:decorator serviceName

Produces 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 angular-ui-router:controller user --coffee

Produces app/scripts/controller/

  .controller 'UserCtrl', ($scope) ->

A project can mix CoffeScript and JavaScript files.

Minification Safe

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. By providing the --minsafe option, the code generated will out-of-the-box be ready for minification. The trade-off is between amount of boilerplate, and build process complexity.


yo angular-ui-router:controller user --minsafe

Produces app/controller/user.js:

angular.module('myMod').controller('UserCtrl', ['$scope', function ($scope) {
  // ...



angular.module('myMod').controller('MyCtrl', function ($scope, $http, myService) {
  // ...


  ['$scope', '$http', 'myService', function ($scope, $http, myService) {

    // ...

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 ngmin, a tool that automatically adds these annotations. However, if you’d rather not use ngmin, you have to add these annotations manually yourself.

Bower Components

The following packages are always installed by the app generator:

  • angular
  • angular-mocks
  • angular-scenario

The following additional modules are available as components on bower, and installable via bower install:

  • angular-cookies
  • angular-loader
  • angular-resource
  • angular-sanitize
  • angular-ui-router

All of these can be updated with bower update as new versions of AngularJS 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-testt",
  "version": "0.0.0",
  "appPath": "public"

This will cause Yeoman-generated client-side files to be placed in public.


For tests to work properly, karma needs the angular-mocks bower package. This script is included in the bower.json in the devDependencies section, which will be available very soon, probably with the next minor release of bower.

While bower devDependencies are not yet implemented, you can fix it by running:

bower install angular-mocks

By running 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 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.


BSD license

Related Repositories



I add "ui-router" in this module. Fork from ...



All In One AngularJS generator(Material Design/Gulp/ui-router). ...



Yeoman generator for an angular.js site. CoffeeScript, stylus, jade, gulp.js. Bootstrap, angular-strap, nib, angular-ui-router. Heroku + s3 deployment tasks included. ...



Yeoman Generator for angular that uses Webpack as a module bundler, SASS as CSS preprocessor, UI router as default angular route, Karma with Jasmine for testing and Auto-generated Docs. ...



快速生成`angular`+ `bootstrap` + `ui-router`的admin后台系统 ...

Top Contributors

btford passy sindresorhus robinboehm iamblue kevva eddiemonge addyosmani sleeper stephenplusplus mklabs samaxes vlad begeeben chicoxyzzy artoale iknite nickgulya vstirbu exromany adambarthelson pensierinmusica BGR360 blakeblackshear claydiffrient dancancro danielmcormond dhageman davemo DruRly


-   0.5.3 zip tar