Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 2.7 KB

README.md

File metadata and controls

74 lines (55 loc) · 2.7 KB
Raw

Yeoman generator for the Kickoff framework

stability NPM version Downloads

Using our Yeoman Generator is the best and fastest way to get Kickoff each time you want to start a new project. It will ask you a few questions and then build a custom version of Kickoff version 6 for your needs.

What is Yeoman?

Yeoman helps you kickstart new projects, prescribing best practices and tools to help you stay productive. Yeoman is open-source but is maintained by a number of people from Google.

We have created a generator that once installed, allows you to create a custom build of Kickoff whenever you need.

Installation

Install Yeoman

If you haven't installed Yeoman yet, run this command in your terminal:

npm install -g yo

Install the generator

To install generator-kickoff from npm, run:

npm install -g generator-kickoff

Install them both :)

npm install -g yo generator-kickoff

Finally, initiate the generator:

yo kickoff

The Kickoff generator asks for this information:

  1. Project name
  2. Description
  3. Developer's names?
  4. Features
  5. Does this project support IE8?
  6. Include Kickoff's styleguide?
  7. Use Kickoff Statix for static templating and rapid prototyping?
  8. Use Grunticon?
  9. Use Browserify to bundle your Javascript?
  10. Choose your javascript namespace (only seen if above question is false)
  11. Which javascript libraries would you like to use?
  12. jQuery v1.x
  13. jQuery v2.x
  14. trak.js - Universal event tracking API
  15. Swiftclick - Eliminates the 300ms click event delay on touch devices
  16. Include some Javascript polyfills/shims? (These are generated by the grunt shimly command)
  17. Use Modernizr?

The repo and more information can be found at github.com/TryKickoff/generator-kickoff

If you'd like to get to know Yeoman better check out the complete Getting Started Guide.

License

MIT License