Vanilla Pattern Lab is a barebones UI starter kit that uses Pattern Lab Node.
In order to get Pattern Lab up and running in your local environment, run the following commands in your terminal:
git clone https://github.com/bradfrost/vanilla-pl.git && cd vanilla-pl
- If gulp is not installed on your computer, install it using
npm install gulp-cli -g
in the command line. - In the command line, navigate to the root of the project, then run
npm install
to download the project's dependencies. - Run
gulp patternlab:serve
to build Pattern Lab and watch for changes. - Visit
http://localhost:3000/
in your browser to view Pattern Lab.
Please view Pattern Lab's documentation for info on how to use the tool.
These are some helpful commands you can use on the command line for working with Pattern Lab.
Reminder: These commands assume a global installation of gulp 4.X, instead of a local installation.
To list all available commands type:
gulp patternlab:help
To generate the front-end for Pattern Lab type:
gulp patternlab:build
To watch for changes, re-generate the front-end, and server it via a BrowserSync server, type:
gulp patternlab:serve
BrowserSync should open http://localhost:3000