generator-angular-blueprint

Yeoman generator

Angular js Generator for large scale applications.

Prerequisites

npm i -g bower yo

If you get permission errors run sudo !!

Based on John Papa's AngularJS Style Guide. The goal is to have an out of the box scaffolding that will scale well for large complex applications.

To see a sample generated project look here.

Generator Angular Blueprint introducing the idea of blueprints to an angular scaffolding. It is now very simple to overwrite generator templates in your local project. Lots of Yeoman generators are out there, but what if you don't agree? You can fork the repo and make changes and install it on your own, OR, you can use generator-angular-blueprints. Don't like the style of comments we have chosen? Use your own! Simply run the 'blueprint' generator to customize your own templates.

npm install -g generator-angular-blueprint

Generators

App

Generates the main application scaffolding

yo angular-blueprint

Blueprint

Generates a blueprint to be customized. The template file will be placed into your local project. From there you can customize the template any way that you like.

Example:

yo angular-blueprint:blueprint
[?] Which blueprint would you like to create?
1)  controller
2)  controller-spec
3)  view
4)  style
5)  service
6)  service-spec
7)  factory
8)  factory-spec
9)  directive
10) directive-html
11) directive-html-spec
12) directive-spec
13) route

Produces:

blueprints/templates/controller/template.js

The following template values are passed in to each template and are available for you to use:

<%= appName %> // myApp
<%= classedName %> // ClassedName
<%= cameledName %> // cameledName,
<%= dashedName %> // dashed-name
<%= humanName %> // human name
<%= type %> // {controller|factory|service|directive}

Route

Generates a new route and all of its components

Example:

yo angular-blueprint:route home
[?] Where should I generate "home"? (./client/app/views/home)

Produces:

client/app/views/home/home.controller.js
client/app/views/home/home.controller.spec.js
client/app/views/home/home.route.js
client/app/views/home/home.view.html
client/app/views/home/home.view.scss

Controller

Generates a new controller

Example:

yo angular-blueprint:controller home
[?] Where should I generate "home"? (./client/app/views/home)

Produces:

client/app/views/home/home.controller.js
client/app/views/home/home.controller.spec.js

Factory

Generates a new Angular Factory

Example:

yo angular-blueprint:factory user
[?] Where should I generate "user"? (./client/app/services/user)

Produces:

client/app/services/user/user.factory.js
client/app/services/user/user.factory.spec.js

Directive

Generates a new Angular Directive.

Example:

yo angular-blueprint:directive nav
[?] Where should I generate "nav"? (./client/app/components/nav)

Produces:

client/app/components/nav/nav.directive.js
client/app/components/nav/nav.directive.spec.js

Directive-html

Generates a new Angular Directive with an external template.

Example:

yo angular-blueprint:directive-html nav
[?] Where should I generate "nav"? (./client/app/components/nav)

Produces:

client/app/components/nav/nav.directive.js
client/app/components/nav/nav.directive.html
client/app/components/nav/nav.directive.scss
client/app/components/nav/nav.directive.spec.js

Service

Generates a new Angular Service

Example:

yo angular-blueprint:service user
[?] Where should I generate "user"? (./client/app/services/user)

Produces:

client/app/services/user/user.service.js
client/app/services/user/user.service.spec.js

Filter

Generates a new Angular Filter

Example:

yo angular-blueprint:filter reverse
[?] Where should I generate "reverse"? (./client/app/filters/reverse)

Produces:

client/app/filters/reverse/user.filter.js
client/app/filters/reverse/user.filter.spec.js

View

Generates a new Angular View

Example:

yo angular-blueprint:view about
[?] Where should I generate "about"? (./client/app/views/about)

Produces:

client/app/views/about/user.view.html
client/app/views/about/user.view.scss

Features

To start the development server

npm start

To run unit tests

npm test

To build app for deployment

npm run build

To build app for deployment with tests and docs

npm run build-full

If you are using the JSDoc style of comments (which you should!!!) you can generate your documentation with the following command. Documentation can be found under docs/client/ (Hooray for automated documentation!)

npm run docs

API Proxying

Angular-blueprint includes grunt-connect-proxy to hit outside APIs for development.

The proxy is set up for the github API right now but can can be configured easily to hit your own api. (Yes I know Github's api does not require this).

Angular Blueprint has a switch for proxying APIs. To turn it on set appConfig.proxy = true

var appConfig = {
  app: require('./bower.json').appPath || 'app',
  dist: 'dist',
  proxy: false, // <-- HERE HERE DO IT HERE!!!
  proxyConfig: [{
    context: '/api',
    host: 'api.github.com',
    port: 443,
    https: true,
    changeOrigin: true,
    rewrite: {
      '^/api': ''
    }
  }]
};

To contribute

git clone https://github.com/deebloo/generator-angular-blueprint.git

To run unit tests

npm test

To run the full test suite (runs the unit tests as well as testing the generator end to end). This is the same tests that are run on circle ci

sh test.sh

To install generator

npm link

this should allow you to run

yo angular-blueprint

smrubin / generator-angular-blueprint Goto Github PK