php

The requirements for Pattern Lab 2 vary depending on what features you want to use.

Minimum Requirements

To use the basic features of Pattern Lab to compile patterns, you must have PHP 5.4+ installed. On Mac OS X Pattern Lab should work “out of the box.” If you’re on Windows you can download PHP from PHP.net. Pattern Lab comes with its own built-in web server.

Because Pattern Lab’s output consists of HTML, CSS, and JavaScript there are no requirements for hosting your Pattern Lab site. Simply upload the ./public/ directory to your host and you should be good to go.

Pattern Lab uses Composer to manage project dependencies. While Pattern Lab can be downloaded as a Zip we highly recommend installing Composer so you can easily update your project in the future. Please follow the directions for installing Composer on the Composer website. We recommend you install it globally.

node

The requirements for Pattern Lab 2 vary depending on what features you want to use, but all have the same foundation.

Minimum Requirements

Pattern compilation is done with Node, uses npm to manage project dependencies, and either gulp.js or grunt.js to run tasks and interface with the core library. Node 4.X+ suffices. You can follow the directions for installing Node on the Node website if you haven’t done so already. Installation will include npm. Pattern Lab comes with its own webserver.

Because Pattern Lab’s output consists of HTML, CSS, and JavaScript there are no requirements for hosting your Pattern Lab site. Simply upload the ./public/ directory to your host and you should be good to go.

It’s also highly recommended that you install gulp or grunt globally.

Note: The Node Gulp Edition of Pattern Lab uses Gulp 4, which may require a new global install of the Gulp command line interface. Follow the gulp upgrade instructions if you already have gulp installed and need to upgrade. Gulp 4 is in alpha, but brings many benefits to the table and is relatively stable.