An open API service indexing awesome lists of open source software.

https://github.com/isramv/gen-8-pattern-lab

Generic D8 Pattern Lab
https://github.com/isramv/gen-8-pattern-lab

drupal lab pattern

Last synced: 12 months ago
JSON representation

Generic D8 Pattern Lab

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/pattern-lab/edition-php-drupal-standard.svg?branch=master)](https://travis-ci.org/pattern-lab/edition-php-drupal-standard)

# Pattern Lab Twig Standard Edition for Drupal

The Standard Edition for Drupal gives developers and designers a clean and stable base from which to develop a Drupal compatible pattern library.

## Prerequistes

- [`composer`](https://getcomposer.org)

## First Time Install

1. Run `composer create-project pattern-lab/edition-drupal-standard FOLDERNAME` (Assuming you wanted it in a directory called `FOLDERNAME`).
1. Select a starterkit from menu. If asked about replacing files, do it.
1. Commit new files generated.

## Using It

After installing and committing, others cloning the repo need to run `composer install` to install dependencies.

## Helpful Commands

These are some helpful commands you can use on the command line for working with Pattern Lab.

### One line start

This will compile PL and watch for changes while running the local server:

composer start --timeout=0

### Generate Pattern Lab

To generate the front-end for Pattern Lab type:

php core/console --generate

### 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 separate window type:

php core/console --server

Then open [http://localhost:8080](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

### Updating Pattern Lab

composer update

## Other Documentation

These are crucial pieces that contains documentation that is good to understand:

- [`pattern-lab/patternengine-twig`](https://github.com/pattern-lab/patternengine-php-twig)
- [`aleksip/plugin-data-transform`](https://github.com/aleksip/plugin-data-transform)
- [Twig templating language](http://twig.sensiolabs.org/documentation)