Kratos Boilerplate

This project uses Pug, Stylus, Gulp and Browsersync.

Maybe you want to read about them:

For grid system uses Lost with some help from Rucksack for animations, reset and a lot of great mixins, Rupture for responsive utilities. And Font Magician to get the webfonts.

Getting Started

Installation

First of all, install the dependencies to run this boilerplate.

# Clone this repository
$ git clone git@github.com:LFeh/kratos-boilerplate.git
$ cd kratos-boilerplate

# install gulp globally
$ npm install -g gulp

# install dependencies
$ npm run setup

With the commands above, you have everything to start.

Folders and Files

├── README.md
├── build
│   ├── css
│   │   └── style.css
│   ├── img/
│   ├── svg/
│   ├── js
│   │   └──  main.js
│   ├── styleguide/
│   ├── index.html
├── gulpfile.js
├── package.json
└── src
    ├── img/
    ├── svg/
    ├── js/
    ├── styl
    │   ├── _core/*.styl
    │   ├── vendors/*.styl
    │   ├── quarks/*.styl
    │   ├── atoms/*.styl
    │   ├── molecules/*.styl
    │   ├── organisms/*.styl
    │   ├── pages/*.styl
    │   └── style.styl
    └── pug
        └── index.pug

Those folders and file will change during the project.

Code Standards

This project uses my own Coding Style as code reference.

This project also uses Husky to prevent commit and push messy and wrong code.

To help you, this project has a npm run fix command to fix all eslint errors.

Parker CSS

To view a reporter of CSS files, use a npm run reporter command.

Tasks

npm start: run all tasks and initialize watch for changes and a server
npm test: lint javascript and css
npm run setup: install all dependencies
npm run fix: command to fix all eslint errors
npm run reporter: test css complexity
npm run build: run all tasks to build
gulp js: execute js files
gulp html: compile pug files
gulp css: compile stylus files
gulp images: compress image files
gulp icons: generate sprite of icons

Credits

This boilerplate uses as a base the awesome Qualy Boilerplate by @Willian_justen ❤️

giripe/kratos-boilerplate