# kickoff-framework > A lightweight front-end framework for creating scalable, responsive websites Latest version **8.0.0-rc.2** (published 2017-01-01) · MIT license · 0 weekly downloads ## Install ```sh npm install kickoff-framework pnpm add kickoff-framework yarn add kickoff-framework bun add kickoff-framework ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 8.0.0-rc.2 | | Published | 2017-01-01 | | First published | 2015-10-25 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=6.0 | | Dependencies | 11 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 465 | | Maintainers | mrmartineau | | Keywords | kickoff, ⚽ | ## Links - npm: https://www.npmjs.com/package/kickoff-framework - Repository: https://github.com/TryKickoff/kickoff - Homepage: http://trykickoff.com - Issues: https://github.com/TryKickoff/kickoff/issues - npm.io page: https://npm.io/package/kickoff-framework ## Dependencies (11) - [console](https://npm.io/package/console.md) 0.5.2 - [copy-js](https://npm.io/package/copy-js.md) 0.1.1 - [lite-ready](https://npm.io/package/lite-ready.md) 1.0.4 - [double-dollar](https://npm.io/package/double-dollar.md) 1.0.0 - [include-media](https://npm.io/package/include-media.md) 1.4.9 - [svg4everybody](https://npm.io/package/svg4everybody.md) 2.1.4 - [normalize-scss](https://npm.io/package/normalize-scss.md) 6.0.0 - [kickoff-grid.css](https://npm.io/package/kickoff-grid.css.md) 1.1.1 - [kickoff-utils.scss](https://npm.io/package/kickoff-utils.scss.md) 2.0.3 - [kickoff-welcome.js](https://npm.io/package/kickoff-welcome.js.md) 1.3.0 - [kickoff-fluidVideo.css](https://npm.io/package/kickoff-fluidVideo.css.md) 1.1.0 ## Recent versions - 8.0.0-rc.2 (latest) — 2017-01-01 - 6.0.0 (beta) — 2015-10-25 ## README ![Kickoff](http://i.imgur.com/bfMlVwe.jpg) > A lightweight front-end framework for creating scalable and performant, responsive sites [![devDependency Status](https://david-dm.org/trykickoff/kickoff/dev-status.png)](https://david-dm.org/trykickoff/kickoff#info=devDependencies) [![Build status](https://ci.appveyor.com/api/projects/status/g699smb2tsoakc8k/branch/master?svg=true)](https://ci.appveyor.com/project/mrmartineau/kickoff/branch/master) [![Dependency Status](https://dependencyci.com/github/TryKickoff/kickoff/badge)](https://dependencyci.com/github/TryKickoff/kickoff) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) [![bitHound Overall Score](https://www.bithound.io/github/TryKickoff/kickoff/badges/score.svg)](https://www.bithound.io/github/TryKickoff/kickoff) Developed and maintained by [Ashley Nolan](https://github.com/ashleynolan) & [Zander Martineau](https://github.com/mrmartineau) ## Features | | Feature | Description | |---------------- |---------------------------- |----------------------------------------------------------------------------------------------- | | :fast_forward: | #webperf | Performance-first, responsive philosophy | | :oncoming_bus: | Rock-solid build tasks | We use gulp & webpack to deliver the best task runner & developer experience for your project | | :eyeglasses: | Unopinionated & extendable | A few common UI elements, a grid & some other base styles. The rest is up to you. | | :crystal_ball: | Future proof | Build complex layouts with flexbox. Our grid | | :angry: | Lean & mean | CSS: 8.68 kB gzipped
JS: 2 kB gzipped
It is a boilerplate after all :wink: | ## Tasks | | Task | Description | |---|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---| | :art: | CSS | `npm run compile:css` - [Sass](http://sass-lang.com/) ([Libsass](http://sass-lang.com/libsass) via [node-sass](https://github.com/sass/node-sass)), [Postcss](http://postcss.org/) with [Autoprefixer](https://github.com/postcss/autoprefixer), [CSSNano](https://github.com/ben-eb/cssnano) and more, Source Maps | | :elephant: | Javascript | `npm run compile:js` - [Babel](http://babeljs.io/), [Webpack](http://webpack.github.io/) | | :ferris_wheel: | Images | `npm run compress:images` - Compression with [imagemin](https://www.npmjs.com/package/gulp-imagemin) | | :fish: | Icons | `npm run compile:svg` - Auto-generated [SVG Sprites](https://github.com/w0rm/gulp-svgstore) | | :construction: | Compile | `npm run compile:all` - Compile all the things | | :eyes: | Watch | `npm run watch` - Watch all the things | | :fire: | Live updating | `npm start` - Basic dev server using [Browsersync](http://www.browsersync.io/) | | :shipit: | Production builds | `npm run compile:release`, or add the ` --release` flag to any other task, e.g. `gulp javascript --release` or `gulp css --release` | --- ## :memo: Demos and documentation Kickoff's demo and documentation site is hosted at [trykickoff.com](http://trykickoff.com/). --- ## ![Kickoff Yeoman generator](http://i.imgur.com/rWftxao.png?1) 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](http://trykickoff.com/learn/yeoman.html) for more info. --- ### ![Slack logo](http://i.imgur.com/1LNs3Q6.png?1) [Need real-time help? Find us on Slack](https://slackin-trykickoff.herokuapp.com/) --- ## :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](https://github.com/TryKickoff/kickoff/issues/new). --- ## Browser compatibility Kickoff has been tested in the following browsers: | [Chrome](https://www.google.com/chrome/) (latest) | [Firefox](https://www.mozilla.org/en-GB/firefox/new/) (latest) | [Internet Explorer](https://en.wikipedia.org/wiki/Internet_Explorer_9) (9+) | [Safari](https://www.apple.com/safari/) (latest) | [Safari (iOS)](https://www.apple.com/safari/) (latest) | [Opera](https://www.opera.com/) (latest) | |:---------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------:| | Chrome | Firefox | IE | Safari | Safari| Opera | --- ## Maintainers and contributors | Zander Martineau | Ashley Nolan | Nic Bell | |:-------------------------------------------------------------------:|:--------------------------------------------------------------------:|:-----------------------------------------------------------------:| | ![Zander](https://avatars0.githubusercontent.com/u/64883?v=3&s=100) | ![Ashley](https://avatars3.githubusercontent.com/u/805184?v=3&s=100) | ![Nic](https://avatars3.githubusercontent.com/u/151842?v=3&s=100) | | [Twitter](http://twitter.com/mrmartineau) | [Twitter](http://twitter.com/AshNolan_) | [Twitter](http://twitter.com/nicbell) | | [Github](https://github.com/mrmartineau/) | [Github](https://github.com/ashleynolan) | [Github](https://github.com/nicbell/) | | [Site](http://martineau.tv) | [Site](http://ashleynolan.co.uk) | [Site](http://nicbell.net) | ### 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](http://twitter.com/TryKickoff). ### Contributing Please read our [contribution guidelines](https://github.com/TryKickoff/kickoff/wiki/Contributing-to-Kickoff) 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](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible. --- ### Sponsored by ![TMW Unlimited...](http://i.imgur.com/KIUIgi8.png?1) 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 and stickers. --- _Source: https://npm.io/package/kickoff-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._