aleksip/edition-php-tpl

Pattern Lab Edition for PHPTemplate

Pattern Lab Edition for PHPTemplate

The Edition for PHPTemplate gives developers and designers a clean and stable base from which to develop a PHPTemplate-based pattern library., _(*1)

Packaged Components

The Edition for PHPTemplate comes with the following components:, _(*2)

• pattern-lab/core: GitHub, Packagist
• aleksip/patternengine-tpl: GitHub, Packagist
• pattern-lab/styleguidekit-assets-default: GitHub, Packagist
• aleksip/styleguidekit-tpl-default: GitHub, Packagist
• aleksip/plugin-data-transform: GitHub, Packagist

Installing

Pattern Lab uses Composer to manage project dependencies., _(*3)

1. Install Composer

Please follow the directions for installing Composer on the Composer website. We recommend you install it globally., _(*4)

2. Install the Edition for PHPTemplate

Use Composer's create-project command to install the Edition for PHPTemplate into a location of your choosing. In Terminal type:, _(*5)

cd install/location/
composer create-project aleksip/edition-php-tpl your-project-name && cd $_

This will install the Edition for PHPTemplate into a directory called your-project-name in install/location/. During the set-up process you will be asked to install an appropriate StarterKit. You will be automatically dropped into the project directory after the process is finished., _(*6)

Updating Pattern Lab

To update Pattern Lab please refer to each component's GitHub repository. The components are listed at the top of the README., _(*7)

Helpful Commands

These are some helpful commands you can use on the command line for working with Pattern Lab., _(*8)

List all of the available commands

To list all available commands type:, _(*9)

php core/console --help

To list the options for a particular command type:, _(*10)

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

Generate Pattern Lab

To generate the front-end for Pattern Lab type:, _(*11)

php core/console --generate

Watch for changes and re-generate Pattern Lab

To watch for changes and re-generate the front-end for Pattern Lab type:, _(*12)

php core/console --watch

Start a server to view Pattern Lab

You can use PHP's built-in web server to review your Pattern Lab project in a browser. In a seperate window type:, _(*13)

php core/console --server

Then open http://localhost:8080 in your browser., _(*14)

Install a StarterKit

To install a near-empty StarterKit as a starting point for your project type:, _(*15)

php core/console --starterkit --init

To install a specific StarterKit from GitHub type:, _(*16)

php core/console --starterkit --install <starterkit-vendor/starterkit-name>