haukurk/angularjs-app-seed

My idea of an AngularJS application seed

Note - This is not recommended by me anymore. Look at my Webpack+AngularJS 1.5 repo for more to-date project.

Angular App Seed with Gulp build system!

This seed is simple and to the point. If you want something more fancy and complicated, I recommend you to check out AngularJS generator for Yeoman.

Key features.

1. Gulp - Use Gulp to minify and build project files and watch for changes while you code.
2. AngularJS Structure - Structure that makes sense and is used by the AngularJS community.
3. AngularJS Filters - Built-in filters that I find useful.
4. Bower - Utilize Bower to have your JS libraries under control.
5. Bootstrap - Bootstrap front-end framework and including bootstrap directives ([http://angular-ui.github.io/bootstrap/]) for AngularJS.
6. Icons - FontAwesome and Ionic awesomeness to use with your Bootstrap front-end.
7. Helpers - Libraries that is a must for every major web application: Moment, Underscore and jQuery Core.
8. Sass - Allows to use Sass as a project styling preprocessor. Sass is built with gulp-sass nodeJS package.

Prerequisites

• node.js [http://nodejs.org/]
• npm [http://www.npmjs.org/]
• bower [http://bower.io/]
• gulp.js [http://gulpjs.com/]

Installation and Usage

First of all you need to have [Node.js] (http://nodejs.org/).

Install bower globally

npm install -g bower

Install requirements

npm install

Install bower requirements (AngularJS, jQuery etc.)

bower install

Build project and watch for changes.

gulp

Build project.

gulp build

Watch for changes and build when occurred.

gulp watch

AngularJS Project Structure

This seed proposes the following structure.

.
+-- app
¦   +-- app.js
¦   +-- css
¦   +-- fonts
¦   +-- images
¦   +-- js
¦       +-- controllers
¦       ¦   +-- controller_example.js
¦       +-- directives
¦       ¦   +-- directive_example.js
¦       +-- factories
¦       |   +-- factory_example.js
¦       +-- filters
¦       |   +-- filterX.js
|       +-- services
|           +-- service_example.js
|           +-- cache
|           ¦   +-- Cache1.js
|           ¦   +-- Cache2.js
|           +-- models
|               +-- Model1.js
|               +-- Model2.js
+-- build
|   +-- assets
|   +-- views
|   index.html
+-- test
+-- gulpfile.js
+-- bower.json
+-- package.json

Other

Pull requests gladly accepted. :)

License

The MIT License (MIT)

Copyright (c) 2014 Haukur Kristinsson

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.