generator-bootstrap-kickstart

#Yeoman Generator for »Bootstrap Kickstart«

	 _-----_
    |       |    .--------------------------.
    |--(o)--|    |   Yeoman Generator for   |
   `---------´   |   »Bootstrap Kickstart«  |
    ( _´U`_ )    '--------------------------'
    /___A___\    
     |  ~  |     
   __'.___.'__   
 ´   `  |° ´ Y ` 

Using this generator will give you a solid base for your Bootstrap based project in a matter of minutes. It will offer you some neat options for using »Bootstrap Kickstart« which will help you with the creation of Bootstrap themes and sites by providing a file structure with focus on maintainibilty and upgradability and a set of useful Grunt Tasks.

Please check the epic README of »Bootstrap Kickstart« to get detailed information about what it’s all about.

Features of this generator

There are tons of options for now :scream:
… but dont be afraid – most of them are optional and you even get to see them all because some are depending on others. Plus the ones that probably don’t change from one project to the other are stored for your convenience.

Option	Description
oldIeSupport	Whether to make use of »html5shiv«, »respondJs« and »jquery-placeholder« and conditional classes
projectName	Used in the generated README, package.json and bower.json
projectDescription	Used in the generated Readme.md, package.json and bower.json
banner	Optionally adds a comment banner containing author name, version and build date to your production files
theme	Name of your Bootstrap theme. Used to name a file and a folder within the LESS directory
customPaths	Option to define the output paths dist, docs, reports
boilerplateAmount	Option to choose the amount of boilerplate code (HTML, LESS and JS examples)
license	Option to define the license type. Defaults to MIT
initialVersion	Option to define the initial version number used in generated package.json and bower.json. Defaults to 0.0.0
authorName	Option to define the author for use in the generated package.json, bower.json and JavaScript files
authorMail	Option to define the author for use in the generated package.json, bower.json and JavaScript files
authorUrl	Option to define the author for use in the generated package.json and bower.json files
projectHomepage, projectRepositoryType, projectRepository	option to define homepage and repository for use in the generated package.json and bower.json files
issueTracker	Option to define the URL to your issue tracker for use in the generated package.json and bower.json files
addDistToVersionControl	Option to decide whether to add the dist directory to version control or include it in .gitignore

Frequent Users, who are tired beeing asked the same questions again and again might use a config file called .yo-rc.json like described here.

---

Quick install guide

For those already using Yeoman.

npm install -g generator-bootstrap-kickstart
yo bootstrap-kickstart

---

Dependencies

• Node.js
• Bower
• Grunt

See detailed installation instructions over here if you are new to this.

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-bootstrap-kickstart from npm, run:

npm install -g generator-bootstrap-kickstart

Finally, initiate the generator:

yo bootstrap-kickstart

Options via command line flags

--skip-cache

Do not remember prompt answers for next run of the generator

Default: false

yo bootstrap-kickstart --skip-cache

--skip-install

Do not automatically install dependencies

Default: false

yo bootstrap-kickstart --skip-install

--yo-rc

Read and apply options from .yo-rc.json and skip prompting

Default: false

yo bootstrap-kickstart --yo-rc

You could place a .yo-rc.json in the directory you are going to run the generator or in any parent directory up to your user directory (~/.yo-rc.json)

This file should contain the options which are otherwise prompted by Yeoman. See the follwoing example .yo-rc.json:

{
  "generator-bootstrap-kickstart": {
    "projectName": "foozy",
    "projectDescription": "boozy",
    "banner": false,
    "theme": "foozel",
    "boilerplateAmount": "Almost nothing - Just the minimum files and folders",
    "license": "MIT",
    "authorName": "Michael Kühnel",
    "authorUrl": "http://micromata.de",
    "authorMail": "[e-mail]",
    "projectHomepage": "",
    "projectRepository": "",
    "issueTracker": "",
    "oldIeSupport": false,
    "customPaths": true,
    "distDirectory": "myDist",
    "docsDirectory": "myDocs",
    "reportsDirectory": "myReports",
    "initialVersion": "1.0.0",
    "addDistToVersionControl": true
  }
}

See Features of this generator.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Contributing to this project

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing.

• Bug reports
• Feature requests
• Pull requests

License

Please be aware of the licenses of the components we use in this project. Everything else that has been developed by the contributions to this project is under MIT License.

Changelog

Version 2.4.0 (2016-10-23)

• eef8ec1 - 2016-10-23: Update Travis config
• e02ab27 - 2016-10-23: Update dependencies of the generator
• 476ad4b - 2016-10-23: Update _Gruntfile.js to the latest bootstrap kickstart release (#41)
• c8273d9 - 2016-10-19: Adding an option to get rid of banners in your production files (#39)