Skip to content

Latest commit

 

History

History
367 lines (258 loc) · 8.01 KB

README.md

File metadata and controls

367 lines (258 loc) · 8.01 KB
Raw

Generator-angm NPM Downloads npm version

AngularJS Modular Generator

AngularJS Yeoman Generator to help you getting started with a new project based on AngularJS/Angular Material or Bootstrap to build large scale applications.

Modular AngularJS Applications with Generator-angm

Disclaimer

The main reason for creating this project, and do not use any other, was the need to optimize the creation time of each application from scratch. It was built using the best practices of development with AngularJS and uses the latest stable version (1.5.0.). The project does not intend to migrate to the new version(2.0) in a short time, we have in mind that this version is very stable and meets most web projects, so when version 2.0 is reasonably stable we do the migration.

Getting Started

Installing Yeoman

Open your Terminal/Shell and type:

npm install -g yo

Installing the ANGM Generator

To install generator-angm from npm, run:

npm install -g generator-angm

Installing Grunt CLI

To run Grunt commands from our terminal, we'll need grunt-cli:

npm install -g grunt-cli

Installing bower-installer

npm install -g bower-installer

The building process will use bower-installer plugin.

Starting an application

From the command line, initiate the generator:

yo angm

You'll receive some prompts to fill with useful informations as Project name, author, what UI: Bootstrap or Angular Material.

Running project on development

Open your Terminal/Shell and type:

grunt dev

After the command your application should start right in your default browser at localhost:4000.

NOTE: after using yo angm command, we recorded some useful informations on .yo-rc.json file created at the project root folder. So you can't execute the generator command to create the application more than one time per folder!

Running project on production

Open your Terminal/Shell and type:

grunt build

The Gruntfile.js already have some tasks like: Concat, Uglify, Injector and template cache.

NOTE: The command will concat and minify all (JS) application files and the HTML templates will be mixed in on file called templates.js, all this files will be injected on index.html.

Built in SubGenerators

Generator-angm have a subgenerator to create your application modules and directives.

  1. Modules
  2. Directives

Modules

To create a module just type on your Terminal/Shell:

yo angm:angm-module

After that, you must entry the module name and choose what files you want to include.

The subgenerator will produce the following directory structure:

	moduleName/
		moduleName.html
		moduleNameModule.js
		moduleNameCtrl.js
		moduleNameRoute.js
		moduleNameService.js
		moduleName-test.js

Note: Subgenerators are to be run from the root directory of your application.

Directives

To create a directive just type on your terminal window:

yo angm:angm-directive

After that you must entry the directive name and choose what dependencies you want, by default we using external templates and external controllers.

The subgenerator will produce the following directory structure:

shared/
		directives/
			directiveName/
				assets/ /* optional folder
				directiveName.html
				directiveNameCtrl.j
				directiveName-test.js

Application files:

View (Html Template)

File: app/modules/moduleName/moduleName.html.

Code:

<div>
	Content from: "Page = moduleName"
</div>

Controller

File: app/modules/moduleName/moduleNameCtrl.js.

Code:

'use strict';

/**
 * @ngdoc function
 * @name appName.controller:moduleNameCtrl
 * @description
 * # moduleNameCtrl
 * Controller of the appName
 */
angular.module('appName')
	.controller('ModuleNameCtrl', ModuleNameCtrl);

	ModuleNameCtrl.$inject = ['Array of Dependencies optional'];

	function ModuleNameCtrl ('Array of Dependencies is the same above') {

	}

Route

File: app/modules/moduleName/moduleNameRoute.js.

Code:

'use strict';

/**
 * @ngdoc function
 * @name appName.route:moduleNameRoute
 * @description
 * # moduleNameRoute
 * Route of the appName
 */
angular.module('appName')
	.config(function ($stateProvider) {
		$stateProvider
			.state('moduleName', {
				url: '/moduleName',
				templateUrl: 'appName/modules/moduleName/moduleName.html',
				controller: 'moduleNameCtrl',
				controllerAs: 'vm'
			});
	});

Module

File: app/modules/moduleName/moduleNameModule.js.

Code:

'use strict';

/**
 * @ngdoc function
 * @name appName.route:moduleNameModule
 * @description
 * # moduleNameModule
 * Route of the appName
 */

 (function() {
   'use strict';

   angular.module('moduleName', []);

 })();

App starter script

File: app/app.js.

Code:

(function() {
	'use strict';

	/**
	 * @ngdoc index
	 * @name app
	 * @description
	 * # app
	 *
	 * Main module of the application.
	 */

	angular.module('Application name', [
		'ngResource',
		'ngAria',
		 'ngMaterial',
		'ngMdIcons',
		'ngCookies',
		'ngAnimate',
		'ngSanitize',
		'ui.router',
		'home',
	]);

})();

App config script

File: app/app-config.js.

Code:

((function () {
	'use strict';

	/**
	 * @ngdoc configuration file
	 * @name app.config:config
	 * @description
	 * # Config and run block
	 * Configutation of the app
	 */


	angular
		.module('ang-modular')
		.config(configure)
		.run(runBlock);

	configure.$inject = ['$stateProvider', '$urlRouterProvider', '$locationProvider', '$httpProvider'];

	function configure($stateProvider, $urlRouterProvider, $locationProvider, $httpProvider) {

		$locationProvider.hashPrefix('!');

		// This is required for Browser Sync to work poperly
		$httpProvider.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';


		$urlRouterProvider
			.otherwise('/dashboard');

	}

	runBlock.$inject = ['$rootScope'];

	function runBlock($rootScope) {
		'use strict';

		console.log('AngularJS run() function...');
	}
})();

Gruntfile tasks

By default, new scripts are added to the index.html file. Using Grunt-injector, but only on setup configuration, after that you must run grunt injector or grunt dev every time you add a new module, directive or script.

Bower Components

The following packages are always installed by the angm-generator:

  • "json3"
  • "es5-shim"
  • "bootstrap"
  • "angular"
  • "angular-resource"
  • "angular-aria"
  • "angular-mocks"
  • "angular-touch"
  • "angular-bootstrap"
  • "angular-ui-router"

NOTE: Angular Material have the following dependencies:

  • angular-material-icons
  • angular-material
  • angular-messages

The following modules are optional on first install:

  • "angular-cookies"
  • "angular-animate"
  • "angular-sanitize"

All of these can be updated with bower update as new versions of AngularJS are released. Always on first install the generator will use the last stable version of all libraries.

Testing

We implemented only one kind of test at this moment: Unit tests. On next weeks e2e tests will be available too.

Running Tests

The tests are written in Jasmine, which we run with the [Karma Test Runner][karma]. We provide a Karma configuration file pre-configured with some default options to run them.

  • the configuration is found at karma.conf.js
  • the unit tests are found on each module created named as moduleName-test.js.

The easiest way to run the unit tests is to use the supplied npm script on package.json file:

npm test

This script will start the Karma test runner to execute the unit tests.

Contribute

To submitting an issue, please check if pass on travis. To submitting a bugfix, write a test that exposes the bug and fails before applying your fix. To submitting a new feature, add tests that cover the feature.

License

MIT