A few seconds.

generator-dhboilerplate

Boilerplate made by David Hellmann #gulp #npm #craftcms #wordpress #vue #twig

YO Generator dhBoilerplate

              dddddddd
              d::::::dhhhhhhh
              d::::::dh:::::h
              d::::::dh:::::h
              d:::::d h:::::h
      ddddddddd:::::d  h::::h hhhhh
    dd::::::::::::::d  h::::hh:::::hhh
   d::::::::::::::::d  h::::::::::::::hh
  d:::::::ddddd:::::d  h:::::::hhh::::::h
  d::::::d    d:::::d  h::::::h   h::::::h
  d:::::d     d:::::d  h:::::h     h:::::h
  d:::::d     d:::::d  h:::::h     h:::::h
  d:::::d     d:::::d  h:::::h     h:::::h
  d::::::ddddd::::::dd h:::::h     h:::::h
   d:::::::::::::::::d h:::::h     h:::::h
    d:::::::::ddd::::d h:::::h     h:::::h
     ddddddddd   ddddd hhhhhhh     hhhhhhh


   dhBoilerplate made with love & help.
   ---------------------------------------
   Author   :   David Hellmann
   Website  :   https://davidhellmann.com
   Github   :   https://github.com/davidhellmann/generator-dhBoilerplate

Install dhBoilerplate

npm i generator-dhboilerplate -g

Start Generator

// Go to your project directory and do that
yo

Intro

That's my own YO Generator who fits for my own requirements. Last year I go most of the time with CodeKit and a more oldsql workflow. Now, this one is more up to date :)

IMPORTANT NOTE

Actually the WordPress Version has no Focus. Craft CMS + Prototyping have priority! But you can use it, no problem.

Big thanks to Sascha Fuchs and his Kittn for a lot of help and inspiration. Also big thanks to Martin Herweg and his YO Generator that help me a lot too. And last but not least thanks to all members from our Slack Channel webdevs — feel free to join us.

What's inside? A lot! :-)

This three scenarios are covered by the generator:

  • Craft CMS — Up to Date
  • Craft CMS Beta 3 — Not for production
  • WordPress — No up to date but a good startpoint
  • Prototyping (with Twig) — No up to date but a good startpoint

Settings

You can find this stuff here: ___src/assets/css/_______settings

  • _settings.borderradius.scss
  • _settings.boxshadows.scss
  • _settings.breakpoints.scss
  • _settings.colors.scss
  • _settings.easings.scss
  • _settings.fontfamilies.scss
  • _settings.fonts.scss
  • _settings.fontsizes.scss
  • _settings.grid.scss

Sass Functions

You can find this stuff here: ___src/assets/css/______tools

  • borderradius('level-x') or br('level-x')
  • boxshadow('level-x') or bs('level-x')
  • color('color-name') or `c('color-name')
  • ease('easing-name') or e('easing-name')
  • fontfamily('font-name') or ff('font-name')
  • space(i) or s(i) to use the default spacing with a custom multiplicator => _settings.grid.scss

Sass Mixins

You can find this stuff here: ___src/assets/css/_______settings

  • @include center — to center an element.
  • @include clearfix — add clearfix stuff magix.
  • @include filter(filter-name, value%) — to use CSS Filters
  • @include fluid($properties, $min-vw, $max-vw, $min-value, $max-value) or @include f($properties, $min-vw, $max-vw, $min-value, $max-value) — to use Fluid CSS Properties dependent to the current viewport. Next level shit!
  • @include fontsize('base', 1) or @include fs('base', 1) — to set a Font Family in Combination with Line Height. Default Line Height => _settings.fontssizes.scss
  • @include make-section($behaviour: fixed) — to create a section
  • @include make-row($factorMin: 1, $factorMax: 1) — to create a row
  • @include make-col($columns: 12) — to create a col
  • @include make-vr($factor: 1) — to create vertical rhythm (margin-top)
  • @include make-section-padding($factor: 1) — to create vertical rhythm (margin-top)
  • @include make-col--padding($factor: 1) — to create col padding
  • @mixin make-section-float($behaviour: fixed) — to create a non flexbox section
  • @mixin make-col-float($columns: 12) — to create a floating col
  • @include offsett(i) — to set an offset for a column. It use margin-left to do that.
  • @include push(i) — to push a column. It use left to do that.
  • @include pull(i) — to pull a column. It use right to do that.
  • @include valign — to arrange a element vertical centered.
  • @include visuallyhidden or @include vh — to hide an element visual.

Install NPM Packages

npm install // yarn install

Initialize Project

gulp init  // npm run init OR yarn init

Default Task with BrowserSync

gulp // npm run dev OR yarn dev

Task for Building

This Task clean the folder, build the stuff from ground up and optimize the images and minifiy JS / CSS files. Ready for live!

gulp build // npm run build OR yarn build

Other Tasks

There are some other Tasks there…

// NPM RUN / YARN COMMANDS
"start": "gulp init",
"dev": "gulp",
"build": "gulp build",
"criticalcss": "gulp criticalcss",
"clean:dist": "gulp clean:dist",
"clean:templates": "gulp clean:templates",
"clean:images": "gulp clean:images",
"clean:js": "gulp clean:js",
"clean:css": "gulp clean:css",
"copy:fonts": "gulp copy:fonts",
"copy:images": "gulp images",
"copy:favicon": "gulp favicon",
"copy:inlinejs": "gulp inlineJS",
"copy:svg": "gulp svg",
"copy:single": "gulp svg-single",
"copy:sprite": "gulp svg-sprite",
"copy:sysfiles": "gulp systemFiles",
"copy:templates": "gulp templates"
// Clean Tasks
// Clean the specific folder in the "___dist" dir
gulp clean:templates
gulp clean:css
gulp clean:js
gulp clean:images
// Main Tasks
// All this are triggered within "gulp init" & "gulp build" task.
// Some of this are triggered within the "gulp" task.
gulp templates
gulp inlineJS,
gulp systemFiles
gulp modernizr
gulp compile:js
gulp sass
gulp copy:fonts
gulp images
gulp svg-single
gulp svg-sprite
// Minify Tasks
// This task are triggered within the "guld build" task.
gulp minify:js
gulp minify:sass
gulp minify:images

Thanks to

  • webdevs - for so many things: Website
  • Sascha Fuchs - for help help help: Website
  • Martin Herweg - for help help help: Website
  • CSS Tricks - for Easing Map: Website
  • Florian Kutschera - for the Material Design Box Shadows: Website
  • Hugo Giraudel & Eduardo Bouças - for include media: Website
  • @LukyVj - for family.scss: Website
  • inuitcss - for some snippets and inspiration: website

bitHound Overall Score

Pincer is a project which aims to provide best library discovery tools for developers. We're growing day by day. We have only npm platform for now but we will add the others as much as we can.