generator-angularjs-skeleton
v1.0.0-rc.1
Published
A Yeoman generator for creating AngularJS project skeleton with set of useful features
Downloads
3
Maintainers
Readme
Generator of AngularJS project skeleton based on Hottowel generator.
The key differences:
- task for angular files generation (controllers, models, directives etc.)
- replaced LESS with SASS
- used decorator which blocks duplicate requests
Preconditions
Install Node.js
Install next NPM modules globally
npm install -g bower gulp nodemon
Install Yeoman
npm install -g yo
Quick Start
Install generator-angularjs-skeleton
npm install -g generator-angularjs-skeleton
Create a new folder for project and step inside it
mkdir myapp cd myapp
Run the generator
yo angularjs-skeleton
Install dependencies
npm install
Start the project and begin coding
gulp serve-dev
Project structure
/src
/client
/app
/core <!-- main module and config files -->
/routes <!-- route files -->
/models <!-- factories -->
/directives <!-- folder with directives -->
/components <!-- folder with components -->
/filters <!-- folder with filters -->
<!-- folders with controllers and corresponding views -->
/main
/dashboard
Gulp tasks
gulp generate
Use gulp tasks listed below to generate your controllers, models, routes etc. easily.
gulp generate --controller controller_name
- will add folder for controller (if it does not exist) and generate controller with nameControllerNameController
gulp generate --model model_name
- will add filemodel_name.model.js
tomodels
folder and generate model with nameModelNameModel
gulp generate --model route_file_name
- will add fileroute_file_name.route.js
toroutes
foldergulp generate --directive directive_name
- will add filedirective_name.directive.js
todirectives
folder and generate directive with namedirectiveName
gulp generate --module module_name
- - will add folder for module (if it does not exist) and generate module with module namemodule_name
You can add
--module [module_name]
to all generators (except module generator) to attach a file to specified module. By default it will be attached toapp.core
gulp vet
Runs jshint and jscs on all javascript files.
gulp test
Runs all unit tests (using Karma runner and next frameworks: mocha, chai and sinon).
gulp styles
Compile scss files to CSS and copy to the build folder
gulp serve-dev
Serves the development code and launches it in a browser. The goal of building for development is to do it as fast as possible, to keep development moving efficiently. This task serves all code from the source folders and compiles sass to css in a temp folder.
gulp build
Copies all fonts, copies images and runs
gulp html
to build the production code to the build folder.gulp serve-build
Serve the optimized code from the build folder and launch it in a browser.
TODOs
- writing more detailed documentation
- generator tests implementation
License
MIT