Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nechik/generator-angularjs-skeleton
A Yeoman generator for creating AngularJS project skeleton with set of useful features
https://github.com/nechik/generator-angularjs-skeleton
angular angular1 angularjs generator skeleton yeoman
Last synced: 3 months ago
JSON representation
A Yeoman generator for creating AngularJS project skeleton with set of useful features
- Host: GitHub
- URL: https://github.com/nechik/generator-angularjs-skeleton
- Owner: NechiK
- License: mit
- Created: 2017-07-28T22:50:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-31T12:35:02.000Z (over 7 years ago)
- Last Synced: 2024-10-11T08:40:48.789Z (3 months ago)
- Topics: angular, angular1, angularjs, generator, skeleton, yeoman
- Language: JavaScript
- Homepage:
- Size: 39.1 KB
- Stars: 5
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/NechiK/generator-angularjs-skeleton)
Generator of AngularJS project skeleton based on [Hottowel](https://github.com/johnpapa/generator-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
1. Install [Node.js](http://nodejs.org)
2. Install next NPM modules globally
```
npm install -g bower gulp nodemon
```
3. Install Yeoman
```
npm install -g yo
```
# Quick Start
1. Install generator-angularjs-skeleton
```
npm install -g generator-angularjs-skeleton
```
2. Create a new folder for project and step inside it
```
mkdir myapp
cd myapp
```
3. Run the generator
```
yo angularjs-skeleton
```
4. Install dependencies
```
npm install
```
5. Start the project and begin coding
```
gulp serve-dev
```
# Project structure
/src
/client
/app
/core
/routes
/models
/directives
/components
/filters
/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 name ```ControllerNameController```
* ``` gulp generate --model model_name``` - will add file ```model_name.model.js``` to ```models``` folder and generate model with name ```ModelNameModel```
* ``` gulp generate --model route_file_name``` - will add file ```route_file_name.route.js``` to ```routes``` folder
* ``` gulp generate --directive directive_name``` - will add file ```directive_name.directive.js``` to ```directives``` folder and generate directive with name ```directiveName```
* ``` gulp generate --module module_name``` - - will add folder for module (if it does not exist) and generate module with module name ```module_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 to ```app.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