mytoysgroup / styleguidekit-assets-default

v0.7.3 2016-01-29 17:14 UTC

Requires

• mytoysgroup/patternlab-php-core: 0.*

MIT

• Ingo Beyerlein
• Mirko Zseby

• twig
• styleguide
• pattern lab

Published on Packagist.org on 2016-01-29 17:22 UTC

README

These static assets are meant to be used with the default Mustache and Twig StyleguideKits. They control the look, feel, and functionality of the front-end of Pattern Lab PHP.

Installation

Pattern Lab PHP uses Composer to manage project dependencies. To install the default static assets run:

composer require pattern-lab/styleguidekit-assets-default

Development Requirements

In order to modify these assets you need to install the following:

• the Development Edition of Pattern Lab PHP
• Node.js and NPM
• Bower
• Ruby Sass

Development Set-up

Once you've installed the requirements do the following to set-up for development:

1. cd /path/to/dev-edition/packages/pattern-lab/styleguidekit-assets-default
2. git config branch.dev.remote origin
3. npm install
4. bower install

Making Changes

To make changes always edit files in src/. To make sure that these changes are reflected in the front-end and dist/ folder run the following:

gulp

To watch for changes you can use:

gulp --watch

At this point changes to the static assets should compile to the correct locations in the project as well as dist/.