Skip to content
This repository has been archived by the owner on Dec 10, 2019. It is now read-only.

Latest commit

 

History

History
60 lines (37 loc) · 3.21 KB

README.md

File metadata and controls

60 lines (37 loc) · 3.21 KB
Raw

📢 Archived in favor of https://github.com/pattern-lab/patternlab-node

Pattern Lab Node

The pure wrapper around Pattern Lab Node Core, the default pattern engine, and supporting frontend assets.

Online Demo of Pattern Lab Output

Packaged Components

This Edition comes with the following components:

  • pattern-lab/patternlab-node: GitHub | npm
  • pattern-lab/patternengine-node-mustache: GitHub | npm
  • pattern-lab/styleguidekit-assets-default: GitHub | npm
  • pattern-lab/styleguidekit-mustache-default: GitHub | npm

Prerequisites

The Pattern Lab Node uses Node for core processing and npm to manage project dependencies. You can follow the directions for installing Node on the Node website if you haven't done so already. Installation of Node will include npm.

Installing

Pattern Lab Node can be used different ways. Editions lilke this one are example pairings of Pattern Lab code and do not always have an upgrade path or simple means to run as a dependency within a larger project. Users wishing to be most current and have the greatest flexibility are encouraged to consume patternlab-node directly. Users wanting to learn more about Pattern Lab and have a tailored default experience are encouraged to start with an Edition. Both methods still expect to interact with other elements of the Pattern Lab Ecosystem.

As an edition, the simplest installation sequence is to clone this repository.

mkdir newApp && cd newApp
git clone https://github.com/pattern-lab/edition-node.git
npm install

Getting Started

This edition comes pre-packaged with a couple simple scripts. Extend them as needed.

build patterns, copy assets, and construct ui

npm run build

build patterns, copy assets, and construct ui, watch source files, and serve locally

npm run serve

logs Pattern Lab Node usage and help content

npm run help

To interact further with Pattern Lab Node, such as to install plugins or starterkits, it's suggested to incorporate the Pattern Lab Node Command Line Interface or learn more about the core API.

Updating Pattern Lab

To update Pattern Lab please refer to each component's GitHub repository, and the master instructions for core. The components are listed at the top of the README.