kotsu

Kotsu

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 jspm globally: npm install -g jspm
5. (optional) Install Ruby and SCSS-Lint gem: gem scss-lint
6. Install GraphicsMagick (recommended) or ImageMagick for your OS. Note: it's mandatory to install one of them before running npm install
7. 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. (optional) Add your repository to Travis for automatic tests
3. (optional) Set up Continuous Deployment with CircleCI or Werker Docker following our guide
4. Code live with: grunt
5. Build with: grunt build
6. Deploy and enjoy your life

What's inside?

• Reasonable structure for frontend projects
• Static pages generation
• Prepared configs for quick Continuous Deployment and automatic tests setup
• Grunt with pre-configured tasks
• Nunjucks, a full featured templating engine
• In-built Nunjucks globals and filters for formatting numbers, dates, getting current page url, locale, breadcrumb, etc.
• Human readable urls
• HTML5 boilerplate files based on best practices
• i18n with node-gettext
• Sass compiler with source maps generation, autoprefixing and linting
• Ekzo.sass framework
• jspm for managing and bundling JavaScript dependencies
• standard for linting and automatic formatting JavaScript
• Live reload powered by Browser Sync
• Automatic sitemap.xml generation with grunt-sitemap-xml
• Automatic sprites generation with Spritesmith
• Automatic images compression via TinyPNG
• Automatic responsive images generation with grunt-responsive-images
• Separate not optimized files in development, and
• Compiled and minified files for production

And a lot more under the hood. We just didn't have time to document all features. Yet.