Yeoman Generator based on the popular ngBoilerplate AngularJS kickstarter. ngBoilerplate is a best-practice boilerplate for scalable Angular projects built on a highly modular, folder-by-feature structure. You work in vertical slices on a daily basis (view, controller, service, etc), so why not organize your projects to optimize your workflow, maximize discoverability, and get copy-paste module reuse for free? This generator is in turn based on the great generator-ngbp from where all the basic code has its origin.
(XX/XX/XX)
- Removed Grunt because it was too hard to keep them both in sync
- Changed LiveReload to BrowserSync
- Changed the names of the view models in the controller/templates to better support future ng-new-router
- We now have to different builds, one for development and one for production
- Removed the template from the generation of service module
- Added Gulp tasks for bumping version
- Changed testing to Mocha
- Fixed tests for Typescript (now all tests are written in Javascript
- Fixed Gulp task "Install"
- Refactored mainly the Javascript to follow John Papa's style guide more.
- Added some comments and show-cases for common scenarios I've struggled with like testing and directives
(03/29/15)
- Fixed some issues in gruntfile.js.
- Fixed some issues in controller, directive and service sub modules.
- Fixed some issues related to TypeScript generation.
(03/28/15) Have done a lot to this generator including:
- Removed CoffeeScript support
- Added TypeScript support
- Added support for nested module names
- Added support for creating controllers, services and directives
- Added some example code as a starter (could be more verbose...pull requests are welcome)
- Added some automation for typescript in the gruntfile to support automatic builds
- Added support for having different file and folder structure than the module/controller/directive/service names. This support was added to enable teams to have their own file and folder structure (like hyphen based or camel case based structures)
- Replaced the "module" sub generator with "controller"
- Enable automatic download of typed definition files for TypeScript (it works but because of some breaking changes in the angular.d.ts file recently where ng was renamed to angular you have to make som manual changes every time they get updated.
- Create a new branch with Angular 1.4 router
Install generator-icengbp from npm, run:
$ npm install -g generator-icengbp
Create a new directory for your project and cd into it:
$ mkdir my-new-project
$ cd my-new-project
Initiate the generator:
$ yo icengbp
icengbp:controller
icengbp:service
icengbp:directive
To create a new module...
$ yo icengbp:controller "controllerName"
$ yo icengbp:service "serviceName"
$ yo icengbp:directive "directiveName"
You can specify the root folder of the module via prompt - default is "app". DON'T include the controller/service/directive name in this path
You have to authorize the overwrite of app.module.js when the subgenerator adds a dependency for your new module (the default is Y, so you can just hit enter at the prompt).
When adding bower modules, always install with
$ bower install some-bower-module --save-dev
Then manually edit the vendor_files.js variable in gulpfile.js to add the full path to the js files you need from the vendor folder. This Gulp variable is what is used to create the script tags in the header of your index.html in the build folder (dev site). When you run "gulp optimize", this same variable is used to add the vendor files to the single, minified js file in the build folder (prod site).
To learn more about ngBoilerplate, click here
MIT