JSPM

generator-kittn

5.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 641
  • Score
    100M100P100Q87909F
  • License MIT

Kittn Scaffolding and Frontend Toolchain

Package Exports

  • generator-kittn

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generator-kittn) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Generator-Kittn

Build Status bitHound Overall Score bitHound Dependencies

kittn-generator

Yeoman Generator for the Kittn Toolkit. Scaffolds and Prepare the Toolkit for you.

Documentation.

IMPORTANT: You need Node >= 7.6 for this generator.

Install

$ npm install -g generator-kittn

Optional

You can use now Yarn with Kittn, instead off NPM. https://yarnpkg.com/

Usage

Jump in your Working Directory and type: 

yo kittn

The Generator will ask you some questions, at the end it will prepare the Project.

Commands

With Webpack you have to use NPM Script Commands

npm run init
Intialize your Project and the Sass Documentation (/sassdocs/)

npm run dev
Main development task with BrowserSync and Webpack

npm run build
Minify JS, Images, CSS. Is for a automated Build Process, comes after a Gulp Init.

npm run scripts
Rebuild all JS Files except the Application JS File

npm run uiimages
Rebuild all Image Files for CSS, copy it to distribution, build Bitmap- and Vector Sprites.

npm run htmlassets
Copy all Imagefiles for Documentusage.

npm run template
Copy all or Generate the Template Files.

npm run favicon
Generate Favicons and the HTML Snippet (generated Files you will find in src/.system/)

New in 4.1.0

Autoprefixer and Babel now use the browserslist-variable from the package.json.

Starterpacks

To make it easier for you to work with Craft or Wordpress, we have also integrated Starterpacks. With the Starterpack you get a Contentbuilder (in the case of Wordpress you still need ACF 5 Pro) and the necessary templates, plugins (free), SCSS and JS files you need.

There is a rudimentary styling, not pretty but functional, as you will usually begin to adapt the existing elements to your project.

In order to activate the Starterpack, you have to decide for a Wordpress or Craft project and decide on the CSS methodology for ITCSS. Then you can install the Starterpack.

Further steps in the documentation.

Dependencies

  • Node >= 7.6
  • Gulp 3.9.1
  • Yeoman 2.0.0
  • Git CLI
  • Wget
  • WP CLI
  • mysql CLI

Special Thanks to

  • David Hellmann (@davidhellmann) - for his Fluidtype Mixin
  • Martin Herweg (@martinherweg) - for his Support with the new generator
  • Hugo Giraudel (@HugoGiraudel) - for his awesome Sass Scripts
  • Team Sass - Jacket

Authors

  • Sascha Fuchs @gisugosu
  • Lars Eichler @cinkon
  • Martin Herweg @martinherweg

Licence

MIT