This project uses Harp, Jade, 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.
First of all, install the dependencies to run this boilerplate.
# Clone this repository
$ git clone git@github.com:LFeh/lfeh.github.io.git
$ cd lfeh.github.io/harp/
# install gulp globally
$ npm install -g gulp
# install harp globally
$ npm install -g harp
# install dependencies
$ npm install
With the commands above, you have everything to start.
├── harp.json
├── README.md
├── gulpfile.babel.js
├── package.json
├── public/
│ ├── _partials/*.jade
│ ├── _src
│ │ └── img/*
│ │ └── styl/*.styl
│ │ └── svg/*.svg
│ ├── _assets
│ │ └── css/style.css
│ │ └── img/*
│ │ └── svg/*.svg
│ ├── blog/
│ ├── lab/
│ ├── projects/
│ ├── 404.jade
│ ├── _layout.jade
│ ├── index.jade
│ ├── rss.xml.jade
│ ├── sitemap.xml.jade
Those folders and file will change during the project.
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.
This project uses as a base the Kratos Boilerplate.
To view a reporter of CSS files, use a npm run reporter
command.
-
gulp css
: compile stylus files -
gulp images
: compress image files -
gulp icons
: generate sprite of icons -
gulp watch
: call for watch files -
npm start
: run all tasks and initialize watch for changes and a server -
npm test
: test the javascript and css complexity -
npm run lint
: test the javascript -
npm run reporter
: test css complexity -
npm run deploy
: deploy to gh pages
MIT License © Luiz Felipe Tartarotti Fialho