pattern-lab / edition-mustache-webdesignday
The Web Design Day Edition of Pattern Lab for Mustache. Installs all Mustache-related dependencies plus the Web Design Day StarterKit.
Requires
- php: >=5.3.6
- pattern-lab/core: ^2.0.0
- pattern-lab/patternengine-mustache: ^2.0.0
- pattern-lab/plugin-faker: ^1.0.0
- pattern-lab/plugin-reload: ^1.0.0
- pattern-lab/styleguidekit-mustache-default: ^3.0.0
This package is not auto-updated.
Last update: 2023-02-15 17:16:54 UTC
README
Pattern Lab Web Design Day Edition for Mustache
The Web Design Day Edition for Mustache gives attendees a clean and stable base from which to follow-along with the Pattern Lab workshop.
Packaged Components
The Web Design Day Edition for Mustache comes with the following components:
pattern-lab/core
: GitHub, Packagistpattern-lab/patternengine-mustache
: documentation, GitHub, Packagistpattern-lab/styleguidekit-assets-default
: GitHub, Packagistpattern-lab/styleguidekit-mustache-default
: GitHub, Packagistpattern-lab/plugin-faker
: GitHub, Packagistpattern-lab/plugin-reload
: GitHub, Packagist
Installing
There are two methods for downloading and installing the Web Design Day Edition for Mustache:
Download a pre-built project
The fastest way to get started with the Web Design Day Edition for Mustache is to download the pre-built version from the releases page.
Please note: Pattern Lab uses Composer to manage project dependencies. To upgrade the Web Design Day Edition for Mustache after the event you'll need to install Composer. We recommend that you install it globally.
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 Web Design Day Edition for Mustache
Use Composer's create-project
command to install the Standard Edition for Twig into a location of your choosing. In Terminal type:
cd install/location/
composer create-project pattern-lab/edition-mustache-webdesignday your-project-name && cd $_
This will install the Web Design Day Edition for Mustache into a directory called your-project-name
in install/location/
. You will be automatically dropped into the project directory after the process is finished.
Installing the Web Design Day StarterKit and Exercise Files
Exercise 1
Type the following where your project was installed:
php core/console --starterkit --suggestions
// when prompted choose 'exercise1start'
php core/console --generate
php core/console --server --quiet & php core/console --watch
Exercise 2
If you would like a clean start with exercise two type the following where your project was installed:
php core/console --starterkit --suggestions
// when prompted choose 'exercise2start' and to replace source
php core/console --generate
php core/console --server --quiet & php core/console --watch
Exercise 3 (Complete)
If you would like a clean start with exercise three type the following where your project was installed:
php core/console --starterkit --suggestions
// when prompted choose 'complete' and to replace source
php core/console --generate
php core/console --server --quiet & php core/console --watch
Updating Pattern Lab
To update Pattern Lab please make sure you've installed Composer. From the root of your project you can then run:
php composer update
Helpful Commands
These are some helpful commands you can use on the command line for working with Pattern Lab.
List all of the available commands
To list all available commands type:
php core/console --help
To list the options for a particular command type:
php core/console --help --[command]
Generate Pattern Lab
To generate the front-end for Pattern Lab type:
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:
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:
php core/console --server
Then open http://localhost:8080 in your browser.
Install a StarterKit
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>
To view the suggested StarterKits for your edition and install one type:
php core/console --starterkit --suggestions