Korat

This package contains a base structure to start a front-end project.

It's called Korat because I'm a crazycat lady and a Korat cat is as small as this starterkit :)

It uses Gulp and Sass.

The gulpfile tasks allow you to:

Compress and concatenate SCSS
Compress and concatenate JS
Generate sourcemaps for each CSS/JS files
Optimize images
Create an SVG sprite usable inline
Include HTML parts (like header/footer...)
Reload your browser at each code update
Check for accessibility issues
Create a clean delivery zip of your project

Installation

Extract this package at the root of your project
Install Gulp globally with npm install -g gulp command
Run the npm install command to install all required node modules
Run gulp command.
Enjoy !

Usage

HTML

The editable HTML (your page template like home.html, contact.html) are in site/html
The included HTML parts (header, footer, everything common to all pages) are in site/inc
The HTML template you create have to be placed in site/html.
A mix will be made with the included files and the result will be generated at the root of the project.

You can refer to site/html/index.html as an example

More doc here: https://www.npmjs.com/package/gulp-file-include

Sprites

Put your SVG icons in the "sprites" folder
Run gulp sprites command.
The sprite file is generated in site/img/global folder and the SCSS is generated in the scss/components folder
Call your icon like this: <svg role="img" focusable="false" class="unicorn" aria-label="Pink fluffy unicorn dancing on rainbow"><use xlink:href="#unicorn"></use></svg>

More doc :

Accessibility check

Just run the gulp axe command. It will report all accessibility issues in your console and in the a11yResult.json file. This file will be located in the aXeReports directory.

More doc :

https://www.npmjs.com/package/gulp-axe-webdriver

List of modules used

History

1.1.0

Add package.json

1.1.1

Modules upgrade

1.2.0

Update npm version to use nodejs version 6.9.1
Remove rem breakpoints
Better a11y on skip links and a11y_hidden class

1.2.1

Better a11y on main regions (tabindex)
Use gulp-sass instead of gulp-compass
Remove config.rb file-include

1.3.0

Modules upgrade
Remove useless sourcemap file
Add accessibility check with axe-webdriver
Remove REM calculation for sprites

2.0.0

Modules upgrade
Moved fonts declarations in _setup.scss
Remove icon-fonts management
Sprites as inline svg
Remove rem convertion and sprites mixins
New media queries system using sass-mq
Add gulp-changed module to optimize only changed or new images
Add gulp-svg-symbols
Add gulp-if to choose where to put svg sprite and its css
Add cheerio to cleanup svg attributes
Add webp and gulp-clone to convert jpg/png/... to webp
Update HTML files

2.0.1

gulp-svg-symbols upgrade
add font-size: 1rem; to svg tag in screen.scss, so they have the correct size

2.1.0

Modules upgrade
Update README file

current version 3.0.0

Gulp v4
Remove Fabricator
Replace gulp-uglify by gulp-terser
Replace gulp-changed by gulp-newer
Modules upgrade
Update README file

Credits

Author: Lena Chandelier

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

lchandelier/korat