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 just a few options for now:

• OldIE support
  • Whether to make use of »html5shiv«, »respondJs« and »jquery-placeholder«
• Project name
  • Used in the generated README, package.json and bower.json
• Project description
  • Used in the generated Readme.md, package.json and bower.json
• Customer theme
  • Used to name things within your LESS files

… more to come :octocat:

---

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

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 1.0.0 (2014-12-14)

• Add changelog
• Add release tasks.
• Test filecontents according to options
• Titleize the project name in HTML titles
• Use spaces for indentation.
• Test file creation
• Get rid linting errors.
• Add grunt to lint code and fire tests.
• Update README.md and add CONTRIBUTING.MD
• Add end message to introduce the grunt tasks.
• Use a random superb like word to describe the generator :smile:
• Replace customerName within LESS files
• Make use of customerName to rename directory and LESS file
• Add new prompt for 'customerName`
• Fix typo and titleize the project name
• Update README
• Add prompted project description to generated README