Skip to content

mrcgrtz/kickstart

Repository files navigation

Kickstart

Kickstart is my opinionated starter kit for frontend development.

GitHub tag XO code style Types MIT License

Features

  • build process using Gulp
  • CSS optimizations using PostCSS
  • TypeScript module transpiling with Browserify
  • some inspirations from HTML5 Boilerplate
  • minimalistic Normalize for good default styling
  • some optimized PHP includes
  • basic search engine optimization

Requirements

Installation

npm install && gulp

Installs all dependencies listed in package.json and runs Gulp’s default task afterwards.

Scripts

Build assets

The default Gulp task using gulp builds CSS/JS files from their sources. CSS files get transformed using PostCSS while TypeScript files get compiled using Browserify.

gulp

Watch changes

To automatically run the Gulp default task after changing a file, start the watch task:

gulp watch

Run tests

There are no actual unit or integration tests (yet). Testing currently includes linting the CSS source files using Stylelint and linting the TypeScript source files using XO:

npm test

License

MIT © Marc Görtz