|
| 1 | + |
| 2 | + |
| 3 | + [](https://gitter.im/pattern-lab/node) |
| 4 | + |
1 | 5 | # Pattern Lab Node |
2 | 6 |
|
3 | 7 | The pure wrapper around [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node), the default pattern engine, and supporting frontend assets. |
4 | 8 |
|
| 9 | +[Online Demo of Pattern Lab Output](http://demo.patternlab.io/) |
| 10 | + |
5 | 11 | ## Packaged Components |
6 | 12 |
|
7 | | -The Gulp Edition comes with the following components: |
| 13 | +This Edition comes with the following components: |
8 | 14 |
|
9 | | -* `patternlab-node`: [GitHub](https://github.com/pattern-lab/patternlab-node), [npm](https://www.npmjs.com/package/patternlab-node) |
10 | | -* `patternengine-node-mustache`: [GitHub](https://github.com/pattern-lab/patternengine-node-mustache), [npm](https://www.npmjs.com/package/patternengine-node-mustache) |
11 | | -* `pattern-lab/styleguidekit-assets-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-assets-default) |
12 | | -* `pattern-lab/styleguidekit-mustache-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-mustache-default) |
| 15 | +* `pattern-lab/patternlab-node`: [GitHub](https://github.com/pattern-lab/patternlab-node) | [npm](https://www.npmjs.com/package/@pattern-lab/patternlab-node) |
| 16 | +* `pattern-lab/patternengine-node-mustache`: [GitHub](https://github.com/pattern-lab/patternengine-node-mustache) | [npm](https://www.npmjs.com/package/@pattern-lab/patternengine-node-mustache) |
| 17 | +* `pattern-lab/styleguidekit-assets-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-assets-default) | [npm](https://www.npmjs.com/package/@pattern-lab/styleguidekit-assets-default) |
| 18 | +* `pattern-lab/styleguidekit-mustache-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-mustache-default) | [npm](https://www.npmjs.com/package/@pattern-lab/styleguidekit-mustache-default) |
13 | 19 |
|
14 | 20 | ## Prerequisites |
15 | 21 |
|
16 | | -The Pattern Lab Node uses [Node](https://nodejs.org) for core processing, [npm](https://www.npmjs.com/) to manage project dependencies, and [gulp.js](http://gulpjs.com/) to run tasks and interface with the core library. Node version 4 or higher suffices. You can follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website if you haven't done so already. Installation of Node will include npm. |
| 22 | +The Pattern Lab Node uses [Node](https://nodejs.org) for core processing and [npm](https://www.npmjs.com/) to manage project dependencies. You can follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website if you haven't done so already. Installation of Node will include npm. |
17 | 23 |
|
18 | 24 | ## Installing |
19 | 25 |
|
20 | | -Forthcoming |
| 26 | +Pattern Lab Node can be used different ways. Editions lilke this one are **example** pairings of Pattern Lab code and do not always have an upgrade path or simple means to run as a dependency within a larger project. Users wishing to be most current and have the greatest flexibility are encouraged to consume `patternlab-node` directly. Users wanting to learn more about Pattern Lab and have a tailored default experience are encouraged to start with an Edition. Both methods still expect to interact with other elements of the [Pattern Lab Ecosystem](https://github.com/pattern-lab/patternlab-node#ecosystem). |
| 27 | + |
| 28 | +As an edition, the simplist installation sequence is to clone this repository. |
| 29 | + |
| 30 | +``` bash |
| 31 | +mkdir newApp && cs newApp |
| 32 | +git clone https://github.com/pattern-lab/edition-node.git |
| 33 | +npm install |
| 34 | +``` |
21 | 35 |
|
22 | 36 | ## Getting Started |
23 | 37 |
|
|
0 commit comments