The Edition for PHPTemplate gives developers and designers a clean and stable base from which to develop a PHPTemplate-based pattern library.
The Edition for PHPTemplate comes with the following components:
pattern-lab/core
: GitHub, Packagistaleksip/patternengine-tpl
: GitHub, Packagistpattern-lab/styleguidekit-assets-default
: GitHub, Packagistaleksip/styleguidekit-tpl-default
: GitHub, Packagistaleksip/plugin-data-transform
: GitHub, Packagist
Pattern Lab uses Composer to manage project dependencies.
Please follow the directions for installing Composer on the Composer website. We recommend you install it globally.
Use Composer's create-project
command to install the Edition for PHPTemplate into a location of your choosing. In Terminal type:
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.
To update Pattern Lab please refer to each component's GitHub repository. The components are listed at the top of the README.
These are some helpful commands you can use on the command line for working with Pattern Lab.
To list all available commands type:
php core/console --help
To list the options for a particular command type:
php core/console --help --[command]
To generate the front-end for Pattern Lab type:
php core/console --generate
To watch for changes and re-generate the front-end for Pattern Lab type:
php core/console --watch
You can use PHP's built-in web server to review your Pattern Lab project in a browser. In a seperate window type:
php core/console --server
Then open https://localhost:8080 in your browser.
To install a near-empty StarterKit as a starting point for your project type:
php core/console --starterkit --init
To install a specific StarterKit from GitHub type:
php core/console --starterkit --install <starterkit-vendor/starterkit-name>