Home

Awesome

Kickoff

A lightweight front-end framework for creating scalable and performant, responsive sites

devDependency Status Build status Dependency Status XO code style bitHound Overall Score

Developed and maintained by Ashley Nolan & Zander Martineau

Features

FeatureDescription
:fast_forward:#webperfPerformance-first, responsive philosophy
:oncoming_bus:Rock-solid build tasksWe use gulp & webpack to deliver the best task runner & developer experience for your project
:eyeglasses:Unopinionated & extendableA few common UI elements, a grid & some other base styles. The rest is up to you.
:crystal_ball:Future proofBuild complex layouts with flexbox & use ES2015 (ES6) for your javascript.
:angry:Lean & meanCSS: 8.68 kB gzipped<br> JS: 2 kB gzipped<br> It is a boilerplate after all :wink:

Tasks

CommandDescription
npm startBasic dev server using Browsersync
npm run watchWatch all files for changes
npm run deployInstall all dependencies and compile all assets for production deployment
npm run compile:allCompile the CSS & JS, compress the images and run any other compilation tasks needed to run your app
npm run compile:releaseAdd the --release flag to any other task, e.g. gulp javascript --release or gulp css --release
npm run compile:cssSass (Libsass via node-sass), Postcss with Autoprefixer, CSSNano, Source Maps & more..
npm run compile:jsBabel, Webpack
npm run compile:svgAuto-generated SVG sprites
npm run compress:imagesImage compression with imagemin
npm run lint:jsLint JS using xo
npm run fix:jsFix JS linting issues using xo
npm run lint:cssLint CSS using stylelint. We use the https://github.com/stylelint/stylelint-config-standard rules for our linting
npm testRun javascript and css tests
npm run clean:allClean the compiled files
npm run copy:allRun the copy tasks - useful for things like webfonts etc
npm run release-patchCreates a patch release using release-it
npm run release-minorCreates a minor release using release-it
npm run release-majorCreates a major release using release-it
npm run release-premajorCreates a premajor release using release-it

:memo: Demos and documentation

Kickoff's demo and documentation site is hosted at trykickoff.com.


Yeoman generator

Our Yeoman Generator is the best way to get Kickoff each time you want to start a new project, visit trykickoff.com/docs/yeoman.html for more info.


Slack logo Need real-time help? Find us on Slack


:bug: Bugs and feature requests

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.


Browser compatibility

Kickoff has been tested in the following browsers:

Chrome (latest)Firefox (latest)Safari (latest)Edge (latest)Opera (latest)
<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_64x64.png" width="48" alt="Chrome"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_64x64.png" width="48" alt="Firefox"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_64x64.png" width="48" alt="Safari"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_64x64.png" alt="Microsoft Edge"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_64x64.png" width="48" alt="Opera">

We also support older versions of Internet Explorer but the support is limited. For example, the Kickoff grid relies on flexbox so Modernizr is needed to detect for it and then we can provide a fallback.


Maintainers and contributors

Zander MartineauAshley NolanNic Bell
ZanderAshleyNic
TwitterTwitterTwitter
GithubGithubGithub
SiteSiteSite

Community

If you're using Kickoff we'd love to hear about it; please e-mail us at trykickoff@gmail.com

Keep track of development and community news by following @TryKickoff on Twitter.

Contributing

Please read our contribution guidelines before contributing to Kickoff.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Kickoff is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.


Sponsored by

TMW Unlimited...

Kickoff was created by Ash and Zander while working at TMW. TMW continue to provide sponsorship for the development of the project as well as trykickoff.com domain renewals, stickers etc.