Skip to content
This repository has been archived by the owner on May 20, 2024. It is now read-only.
/ Kotsu Public archive

✨ Clean, opinionated foundation for new projects — to boldly go where no man has gone before

License

Notifications You must be signed in to change notification settings

LotusTM/Kotsu

Repository files navigation

Kotsu

devDependency Status Travis Build Status Wercker Build Status

Overview

Clean, opinionated foundation for new projects — to boldly go where no man has gone before.

How to use

  1. Clone or download and unpack to desired location
  2. Download and install latest version of node.js
  3. Install grunt-cli globally: npm install -g grunt-cli
  4. Install Ruby and it's Sass (3.4.2 or higher) and SCSS-Lint (optional) gems
  5. Install GraphicsMagick (recommended) or ImageMagick for your OS.
  6. Get your TinyPNG API key and set it as your environment variable:
  • set TINYPNG_API_KEY=YOUR_API_KEY_HERE for Windows
  • export TINYPNG_API_KEY=YOUR_API_KEY_HERE for Linux
  1. Install project dependencies: npm install
  2. Rename Kotsu.sublime-project to project's name
  3. Update _settings.*.scss in styles directory to suit your needs
  4. Code live with: grunt
  5. Build with: grunt build
  6. Deploy and enjoy your life

What's inside?

  • Reasonable structure for frontend projects
  • Grunt with pre-configured tasks
  • Nunjucks, a full featured templating engine with static pages generation
  • Sass compiler with source maps generation, autoprefixing and linting
  • Live reload powered by Browser Sync
  • Optional, but mighty, Ekzo.sass framework
  • HTML5 boilerplate files based on best practices
  • Automatic sprites generation with Spritesmith
  • Images compression via TinyPNG
  • Responsive images generation with grunt-responsive-images
  • Separate, not optimized files in development, and
  • Compiled and minified files for production