README

Pattern Lab Standard Edition for Mustache

The Pattern Lab Standard Edition for Mustache is the evolution of Pattern Lab 1. Pattern Lab is still, at its core, a prototyping tool focused on encouraging communication between content creators, designers, devs, and clients. It combines platform-agnostic assets, like the Mustache-based patterns, with a PHP-based "builder." Pattern Lab 2 introduces the beginnings of an ecosystem that will allow teams to mix, match and extend Pattern Lab to meet their specific needs. It will also make it easier for the Pattern Lab team to push out new features. Pattern Lab Standard Edition for Mustache is just one of the four PHP-based Editions currently available.

Demo

You can play with a demo of the front-end of Pattern Lab at demo.patternlab.io.

Requirements

To use the basic features of Pattern Lab to compile patterns, you must have PHP 5.4+ installed. On Mac OS X Pattern Lab should work "out of the box." If you're on Windows you can download PHP from PHP.net. Pattern Lab comes with its own built-in web server.

Pattern Lab uses Composer to manage project dependencies. It's required if you want to install Pattern Lab using Composer's create-project command or if you want to upgrade Pattern Lab in the future.

Installing

There are two methods for downloading and installing the Standard Edition for Mustache:

Download a pre-built project
Create a project based on this Edition with Composer

Download a pre-built project

The fastest way to get started with Pattern Lab's Standard Edition for Mustache is to download the latest pre-built version from the releases page.

Use Composer to create a project

Pattern Lab uses Composer to manage project dependencies.

1. Install Composer

Please follow the directions for installing Composer on the Composer website. We recommend you install it globally.

2. Install the Standard Edition for Mustache

Use Composer's create-project command to install the Standard Edition for Mustache into a location of your choosing. To create a project do the following:

In a terminal window navigate to where you want to install Pattern Lab
Type composer create-project pattern-lab/edition-mustache-standard patternlab2-example && cd $_
When prompted, type 1 to install the demo StarterKit

This will install the Standard Edition for Mustache along with the demo StarterKit into a directory called patternlab2-example. You will be automatically dropped into patternlab2-example/ when the install is finished.

Note: If you clone or download this repository and use composer install to install the project dependencies you'll need to type the following to install the demo StarterKit:

composer install-demo

Otherwise you'll have a very bare set-up of Pattern Lab.

Get Up and Running

After installing do the following to start and view Pattern Lab:

In a terminal window navigate to the root of your project if you aren't there already
Type php core/console --server --with-watch

You should now be able to open http://localhost:8080 to see your generated site. Any changes you make in ./source/ will automatically rebuild your site and reload your browser.

As you get more comfortable with Pattern Lab you can integrate it with a Gulp or Grunt workflow and drop some of the native Pattern Lab features like automatic browser reload. You can also check out the list of plugins.

Migrating from Pattern Lab 1 to Pattern Lab 2

Pattern Lab 2 was a complete rewrite and reorganization of Pattern Lab 1. Learn about the changes. After installing the Standard Edition for Mustache do the following to migrate from Pattern Lab 1 to Pattern Lab 2:

Copy ./source from your old project to your new install
Copy ./source/_patterns/00-atoms/00-meta/_00-head.mustache to ./source/_meta/_00-head.mustache
Copy ./source/_patterns/00-atoms/00-meta/_01-foot.mustache to ./source/_meta/_00-foot.mustache
Copy ./source/_data/annotations.js to ./source/_annotations/annotations.js

Everything else should work without changes.

Need Pattern Lab 1?

The source code for Pattern Lab 1 is still available for download.

Packaged Components

The Standard Edition for Mustache installs the following components:

pattern-lab/core: GitHub, Packagist
pattern-lab/patternengine-mustache: documentation, GitHub, Packagist
pattern-lab/plugin-reload: GitHub, Packagist
pattern-lab/styleguidekit-assets-default: GitHub, Packagist
pattern-lab/styleguidekit-mustache-default: GitHub, Packagist

List All of the Available Commands and Their Options

To list all available commands type:

php core/console --help

To list the options for a particular command type:

php core/console --help --[command]

pattern-lab / edition-mustache-standard

Maintainers

Details