Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 4.31 KB

README.md

File metadata and controls

68 lines (44 loc) · 4.31 KB
Raw

Pattern Lab Logo

Pattern Lab

This monorepo contains the core of Pattern Lab / Node and all related engines, UI kits, plugins and utilities. Pattern Lab helps you and your team build thoughtful, pattern-driven user interfaces using atomic design principles.

If you'd like to see what a front-end project built with Pattern Lab looks like, check out this online demo of Pattern Lab output.

Build Status current release license Coverage Status code style: prettier node (scoped) Join the chat at Gitter

Using Pattern Lab

Refer to the core usage guidelines

Installation

As of Pattern Lab Node 3.0.0, installation of Editions is accomplished via the command line interface.

The below assumes a new directory and project is required. This is likely what you want to do if starting from scratch. You could also run this within an existing project. The CLI will ask you for the installation location.

  1. Open a terminal window and following along below: 
    mkdir new-project
cd new-project
npm init -y && npx @pattern-lab/cli -c patternlab init

    If you get an error stating that npx is not installed, ensure you are on npm 5.2.0 or later by running npm -v or install it globally with npm install -g npx. Learn more about npx.

  2. Follow the on-screen prompts to choose your Edition and a Starterkit should you want one.
  • If you chose edition-node, new commands in the "scripts" will be added in your package.json.
  • If you chose edition-node-gulp, a gulpfile.js will be added to your project.

Notice that @pattern-lab/cli was installed as a depdendency. Learn how to further use the cli in your own project.

Ecosystem

Pattern Lab Ecosystem

Core, and Editions, are part of the Pattern Lab Ecosystem. With this architecture, we encourage people to write and maintain their own Editions, Starterkits, and even PatternEngines.

Changelog

Each package within this monorepo has its own changelog. Below are the main ones to watch:

Support for Pattern Lab

Pattern Lab / Node wouldn't be what it is today without the support of the community. It will always be free and open source. Continued development is made possible in part from the support of these wonderful project supporters. If you want to learn more about supporting the project, visit the Pattern Lab / Node Patreon page.

💯 Thanks for support from the following:

Contributing

Refer to the contribution guidelines.