|
1 | 1 |  |
2 | 2 |
|
3 | | -  [](https://gitter.im/pattern-lab/node) |
| 3 | +# Pattern Lab Node - Development Edition Engine React |
4 | 4 |
|
5 | | -# Pattern Lab Node - Gulp Edition |
| 5 | +_here be dragons_ |
6 | 6 |
|
7 | | -The Gulp wrapper around [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node), the default PatternEngine, and supporting frontend assets. |
| 7 | +This Development Edition is a variant of [Edition Node Gulp](https://github.com/pattern-lab/patternlab-node/tree/master/packages/edition-node-gulp) for convience purposes only, loaded with the React Engine. The goals of this Development Edition are two-fold: |
8 | 8 |
|
9 | | -## Packaged Components |
| 9 | +* Develop the [React Engine](https://github.com/pattern-lab/patternlab-node/tree/master/packages/engine-react) |
| 10 | +* Build and test against React pattern tree |
10 | 11 |
|
11 | | -This Edition comes with the following components: |
| 12 | +If you'd like to help with the React Engine, please reference the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md). |
12 | 13 |
|
13 | | -* `pattern-lab/patternlab-node`: [GitHub](https://github.com/pattern-lab/patternlab-node) | [npm](https://www.npmjs.com/package/@pattern-lab/patternlab-node) |
14 | | -* `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) |
15 | | -* `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) |
16 | | -* `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) |
17 | | - |
18 | | -## Prerequisites |
19 | | - |
20 | | -This Edition 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. 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. |
21 | | - |
22 | | -## Installing |
23 | | - |
24 | | -Pattern Lab Node can be used different ways. Editions like 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). |
25 | | - |
26 | | -As an Edition, the simplist installation sequence is to clone this repository. |
27 | | - |
28 | | -``` bash |
29 | | -mkdir newApp && cd newApp |
30 | | -git clone https://github.com/pattern-lab/edition-node-gulp.git |
31 | | -npm install |
32 | | -``` |
33 | | - |
34 | | -## Getting Started |
35 | | - |
36 | | -This edition comes pre-packaged with a couple simple gulp tasks. Extend them as needed. |
37 | | - |
38 | | -**build** patterns, copy assets, and construct ui |
39 | | - |
40 | | -``` bash |
41 | | -gulp patternlab:build |
42 | | -``` |
43 | | - |
44 | | -build patterns, copy assets, and construct ui, watch source files, and **serve** locally |
45 | | - |
46 | | -``` bash |
47 | | -gulp patternlab:serve |
48 | | -``` |
49 | | - |
50 | | -logs Pattern Lab Node usage and **help** content |
51 | | - |
52 | | -``` bash |
53 | | -gulp patternlab:help |
54 | | -``` |
55 | | - |
56 | | -To interact further with Pattern Lab Node, such as to install plugins or starterkits, check out the rest of the `gulpfile.js`. You could also install the [Pattern Lab Node Command Line Interface](https://github.com/pattern-lab/patternlab-node-cli) or learn more about the [core API](https://github.com/pattern-lab/patternlab-node#usage). |
57 | | - |
58 | | -## Updating Pattern Lab |
59 | | - |
60 | | -To update Pattern Lab please refer to each component's GitHub repository, and the [master instructions for core](https://github.com/pattern-lab/patternlab-node/wiki/Upgrading). The components are listed at the top of the README. |
| 14 | +> Development Editions of Pattern Lab provide the ability to work on and commit changes to select packages within the overall Pattern Lab [ecosystem](http://patternlab.io/docs/advanced-ecosystem-overview.html). This Edition is NOT stable. |
0 commit comments