generator-boom

An Angular.js generator for Yeoman

npm install generator-boom
14 downloads in the last day
58 downloads in the last week
122 downloads in the last month

Boom Angular.js Generator!


This project is a Yeoman Generator, using which we can speed up our WebApp development. The command name is $ yo boom. Boom because its indeed a BOOM.

You can also check the NPM Repository


What makes it cool

  1. Ultra Fast - Uses Gulp instead of Grunt
  2. Live Reload pre-configured
  3. BrowserSync pre-configured
  4. Development and Production code are separated
  5. AngularUI included (optional)
  6. JSHint pre-configured
  7. Protractor (E2E tests) pre-configured
  8. FontFace - Add @fontface on fly
  9. Constants and Values will be added in main.js (No new file will be created)
  10. Adding Routes will also create and link the css and controller in their respective folders.
  11. Adding Views is also allowed
  12. Adding Styles is also allowed
  13. Use gulp buildfor dev mode and gulp build:prod for production.
  14. Share code with client using command gulp zip (Will create the .zip file of build folder)

Installation

First of all you need to have Node.js and Yeoman npm install -g yo installed.

Install the Boom Generator

    npm install -g generator-boom

Make a new Directory for the project and cd into it

    mkdir my-new-project && cd $_

Then execute the boom command

    yo boom [app-name]

Answer few question on the command prompt and Thats it!


To install the dependency packages (Required only if you need to run the npm install as a super user)

  1. You first need to install all the node modules required by boom.

     npm run-script preinstall
    

    Or else you can directly run npm install

  2. After that you need to download all the libraries using bower.

     npm run-script postinstall
    

    Or else you can directly run bower install


Finally to start the server

    gulp

Or else you can run npm start


App Structure

 - app/
    |- css/
        |- application.scss
        |- fonts.css
    |- fonts/
    |- images/
    |- js/
        |- controllers/
        |- directives/
        |- factories/
        |- filters/
        |- libs/
        |- providers/
        |- services/
        |- app.js
    |- templates/
    |- index.html
    |- bower.json
    |- package.json
    |- Gruntfile.js
    |- gulpfile.js

Boom Commands

Lets quick walk through the boom commands.And understand how quickly we can Setup the entire project with a boom.

The avilable sub-generators are

Special Thanks

I would like to thank following for creating awesome stuff

  • AngularJS - MV* Framework for WebApps
  • Grunt - A JavaScript task runner
  • Gulp - The streaming build system
  • Bower - Front End Package Manager
  • jQuery - DOM Manipulation Library
  • Yeoman - Worlflow for modern WebApps
  • Generator - Yeoman Angular Generator
  • BrowserSync - Keep multiple browsers & devices in sync when building websites

License

The MIT License

Copyright (c) 2014 Aamir Shah (cse.aamir@gmail.com).

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you