Skip to content

riki-felix/patternlab-node

 
 

Repository files navigation

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

Installation is still in flux due to the monorepo transition. Bear with us as we figure this out. Our intent is to ship the Pattern Lab Node CLI soon which will help new and existing users.

In the meantime...

if you already have an Edition tracking 3.X alphas, you can update using the standard instructions.

if you don't mind pulling down everything and playing with it locally, clone this repo and follow the instructions for developing locally.

if you don't yet have a 3.X compatible Edition and want to try something a bit messier (and unsupported for now), you could attempt this workaround.

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.

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.

About

The Node version of Pattern Lab

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.0%
  • CSS 7.7%
  • HTML 5.1%
  • Liquid 0.2%