Pattern Lab Standard Edition

Requirements

• Install NodeJS: https://nodejs.org/en/download/package-manager/ (brew install node)

Optional:

• Install Yarn package manager https://yarnpkg.com/en/docs/install (brew install yarn)

Installation

npm i

Updating the app:

npm up

Start working

See Pattern Lab docs: http://patternlab.io/docs/index.html

Runnig the server

npm run start

Generating and distributing package

To generate the distribution package:

npm run bundle

This will generate the necessary files in the dist directory.

Pushing your changes:

npm run push "Commit message"

This will push all your changes to the repo.

Bump version:

npm version <patch|minor|major>

This will checkout to master, bump version in package.json, create an push the tags.

Using in the site

Download files directly

npm install [email protected]:Aplyca/patternlab-standard.git#master --save

Using bower.json

Create the file in the public directory of the Bundle:

{
  "name": "app-frontend",
  "version": "0.0.1",
  "description": "App Frontend",
  "main": "README.md",
  "repository": {
    "type": "git",
    "url": "ttps://github.com/Aplyca/patternlab-standard"
  },
  "author": "Aplyca",
  "license": "ISC",
  "dependencies": {
    "patternlab-standard-frontend": "git+ssh://[email protected]:Aplyca/patternlab-standard.git#master"
  },
  "devDependencies": {}
}

Then install/update with the command:

npm i --production

Installing the frontend package

See the instructions of the starter kit in source/README.md