Kickstart is a CSS library designed for modularity and fast page performance
HTML JavaScript CSS CoffeeScript Other
Pull request Compare This branch is 3802 commits ahead, 11835 commits behind twbs:master.
Failed to load latest commit information.
core/js-alc Boxing in layouts for 3.x May 29, 2015
gulp Updating some 4.x docs Apr 26, 2016
lib-core Removing unnecessary duplicate code Aug 7, 2015
lib-docs Removing remaining refs to kickstart store May 24, 2016
lib Updating github url Jul 29, 2015
raw Changing icons for throttling page Oct 30, 2014
.gitignore About to create another theme Nov 4, 2014
.gitmodules Updating github url Jul 29, 2015
.npmignore
Gemfile Workable for now. May 3, 2015
Gemfile.lock Workable for now. May 4, 2015
Kickstart.otf Adding menu icon to icon font Oct 2, 2014
README.md Adding bower package Aug 5, 2015
bower.json Adding bower package Aug 5, 2015
build.rb Adding house example Nov 14, 2014
config.rb css finally compiling Aug 29, 2014
gulpfile.js Getting doc builder up and running Oct 27, 2014
makefile Adding amadeus and chopin Mar 24, 2015
package.json Upgrading gulp-mocha-phantomjs Apr 26, 2016
rsync-exclude.txt Adding rsync copy alternative Oct 24, 2014

README.md

Kickstart

Kickstart is a modern front-end CSS library for clean HTML and fast performance.

getkickstart.com

Codeship Status for adamjgrant/kickstart

Code Climate

Quickstart with Gulp

Clone the repository and run make setup in the directory created. This is only required when starting the project.

Run gulp to again build and watch the project. A browser tab should open in your default browser automatically when ready. You'll also get an external URL you can use on other devices.

Alternatively, run gulp build to build the project without watching or creating a server.

Going further

If when running the gulp command, node warns you a module is missing, a dependency probably wasn't installed. It may be enough to run npm install again to catch the missing dependency. In some cases, this problem can be solved by deleting the node_modules directory and running npm install again.

Javascript assets

JavaScript assets can be written as modules in lib/coffee. Add each module to app.coffee in this same directory to output a single, minified JavaScript file with Kickstart.js included.

CSS assets

A style.sass should currently exist in lib/sass. Use this to write your styles, importing any other sass files you create along the way. To change themes, simply change the theme import at the top of the file.

Building getkickstart.com and Kickstart core

Gulp

Directions are similar to the above, however, you should run gulp watch:docs exclusively for docs creation. This will output to /docs instead of /public.

Alternatively, run gulp build:docs to build without watching.

Rails gem and Node.js package

To build gem/package, run make build-all. This will automatically fire up gulp to compile files, bump version numbers, and deploy to NPM/RubyGems.org respectively.

Deployment

  • Deployed with CodeShip
  • master deploys to getkickstart.com
  • stage deploys to stage.getkickstart.com