/FabzTV

My own and exclusive portfolio

Primary LanguageJavaScriptMIT LicenseMIT

devDependency Status Build Status Bitdeli Badge Built with Grunt

Kickoff

Developed and maintained by Ashley Nolan & Zander Martineau

If you're using Kickoff we'd love to hear about it; please e-mail us at labs@tmw.co.uk

Features

  • Built in a mobile-first, responsive philosophy (but can easily be used for fixed sites as well)
  • Sass compilation uses autoprefixer to dynamically add vendor prefixes so you don't even have to think about it
  • Sass mixins for many CSS3 features including gradients, REMs with fallbacks
  • Starter content styles, including clean typography, lists, tables, etc
  • Starter form element styles: stacked on small-screen to 2-column (if you choose) at the breakpoint of your choice
  • Grunt used extensively to ease common development bottlenecks
  • Sass compilation using grunt-contrib-sass although grunt-sass can be used a drop-in replacement but there are still some bugs; it is far quicker though..
  • Concatenation and minification of JS files with and grunt-contrib-uglify
  • Simple server using grunt-contrib-connect

Browser support

Simple: Internet Explorer 8+

Demos and documentation

Please visit tmwagency.github.io/kickoff/ all demos and documentation for Kickoff.

Want to use Grunt?

  • Install Node from nodejs.org
  • Install Grunt CLI - npm install -g grunt-cli
  • Install Sass globally - sudo gem install sass --pre. Ruby v2 is needed. Update using rvm, brew (if you use a Mac) or from ruby-lang.org/en/downloads/ then install the packages below
  • Navigate (cd) to your project directory and run npm install which will install all Grunt's dependencies
  • Run grunt watch or grunt serve (if you want to create a simple local server) to watch for changes and compile Sass/Javascript

When using Grunt with Kickoff, source maps are created for both the Javascript and Sass. Javascript is compiled to the /js/dist and Sass is compiled to the '/css' folder.

Using Git?

Kickoff's .gitignore file ignores the /dist folder by default. You will want to uncomment this line if you are not compiling these on the server.

Yeoman generator

There is also a Yeoman generator for Kickoff, visit tmwagency.github.io/kickoff/docs/yeoman.html for more info.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request