generator-gruntlate v0.2.1

generator-gruntlate

yeoman generator for the basic structure of a web project with a grunt template

Usage

$ mkdir my-project && cd $_

then run this yeoman generator

$ yo gruntlate

What you get

$ grunt
$ grunt serve
$ grunt watch

development (default) or production output (for example css compression on/off):

$ grunt --target=prod|production
$ grunt --target=dev|development

$ grunt css
$ grunt images
$ grunt js

your choices:

1. Project Name (project-name)

2. Project Type

• Website
• Module/Plugin/Library

If Project-Type is "Website":

get a dummy html template (index.html) in dist

.
├── dist
│   ├── resources
│   │   ├── css
│   │   ├── fonts
│   │   ├── img
│   │   └── js
│   └── index.html
├── src
│   ├── css
│   │   ├── _functions.scss
│   │   ├── _mixins.scss
│   │   ├── _variables.scss
│   │   └── main.scss
│   ├── fonts
│   ├── img
│   ├── js
│   │   ├── main.js
│   │   └── module-a.js
│   └── libs
│       └── bower
├── tests
│   ├── .csslintrc
│   └── .eshintrc
├── .bowerrc
├── .editorconfig
├── .gitignore
├── bower.json
├── Gruntfile.js
└── package.json

or instead of the dummy index.html you can also use a dummy jekyll project. the following folders / files will be added

.
├── src
│   └── jekyll
│       ├── _includes
│       │   └── main-navigation.html
│       ├── _layouts
│       │   └── default.html
│       ├── _config.yml
│       └── index.html
└── Gemfile

If Project-Type is "Module/Plugin/Library":

.
├── dist
│   ├── css
│   ├── fonts
│   ├── img
│   └── js
├── src
│   ├── css
│   │   ├── _functions.scss
│   │   ├── _mixins.scss
│   │   ├── _variables.scss
│   │   └── main.scss
│   ├── fonts
│   ├── img
│   ├── js
│   │   ├── main.js
│   │   └── module-a.js
│   └── libs
│       └── bower
├── tests
│   ├── .csslintrc
│   └── .eshintrc
├── .bowerrc
├── .editorconfig
├── .gitignore
├── bower.json
├── Gruntfile.js
└── package.json

If you want to add a Documentation for your "Module/Plugin/Library" the following folders / files will be added

.
├── doc
├── src
│   └── jekyll
│       ├── _includes
│       │   └── main-navigation.html
│       ├── _layouts
│       │   └── default.html
│       ├── _config.yml
│       └── index.html
└── Gemfile

and the following grunt task

$ grunt doc