Pattern Lab Yeoman Generator
A Yeoman generator for Pattern Lab for creating Atomic Design Systems.
Prerequisites
This generator uses Yeoman to scaffold a boilerplate Pattern Lab project. Once scaffolded, this Pattern Lab instance requires the use of Node.js for core processiong and npm for mangement of project dependencies. Additionally, this instance also uses Grunt as a taskrunner and to interface with the core library. It's also highly recommended that you use git for installation and version control.
Installation
- Install Yeoman
npm i -g yo(one-time global installation). - Clone the repo to your system
npm clone https://github.com/laurenhamel/generator-patternlab - Open a terminal and
cdto the location where you cloned the repo - Install the generator globally with
npm link - Create and open a folder for your new project
mkdir <your_project> && cd <your_project> - Scaffold your new project
yo patternlab
Getting Started
If you have successfully completed installation, the Pattern Library should now be loaded on your system and ready to use. To get help with how to manage, build, and deploy patterns, please refer to Pattern Lab's documentation.