You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://gitter.im/pattern-lab/node)
6
10
7
11
# Pattern Lab Node Core
8
12
9
-
This repository contains the core functionality for Pattern Lab Node. Pattern Lab helps you and your team build thoughtful, pattern-driven user interfaces using atomic design principles.
10
-
11
-
[Online Demo of Pattern Lab Output](http://demo.patternlab.io/)
12
-
13
-
## Support for Pattern Lab Node
14
-
15
-
Pattern Lab Node wouldn't be what it is today without the support of the community. It will always be free and open source. Continued development is made possible in part from the support of [these wonderful project supporters](https://github.com/pattern-lab/patternlab-node/wiki/Thanks). If you want to learn more about supporting the project, visit the [Pattern Lab Node Patreon page](https://www.patreon.com/patternlab).
This repository contains the core functionality for Pattern Lab Node.
23
14
24
15
## Installation
25
16
@@ -29,19 +20,18 @@ Pattern Lab Node can be used different ways. Editions are **example** pairings o
29
20
30
21
As of Pattern Lab Node 3.X, `patternlab-node` can run standalone, without the need for task runners like gulp or grunt.
31
22
32
-
`npm install @pattern-lab/patternlab-node`
23
+
`npm install @pattern-lab/core`
33
24
34
25
See [Usage](#usage) for more information.
35
26
36
27
### Editions
37
28
38
29
For users wanting a more pre-packaged experience several editions are available.
39
30
40
-
*[Pattern Lab/Node: Gulp Edition](https://github.com/pattern-lab/edition-node-gulp) contains info how to get started within a Gulp task running environment.
41
-
*[Pattern Lab/Node: Grunt Edition](https://github.com/pattern-lab/edition-node-grunt) contains info how to get started within a Grunt task running environment.
42
-
*[Pattern Lab/Node: Vanilla Edition](https://github.com/pattern-lab/edition-node) contains info how to get started within a pure node environment.
43
-
*[Pattern Lab/Node: Webpack Edition](https://github.com/Comcast/patternlab-edition-node-webpack) contains info how to get started within a webpack environment.
44
-
> Thanks to the team at Comcast for open-sourcing this stellar work!
31
+
*[Pattern Lab/Node: Vanilla Edition](https://github.com/pattern-lab/patternlab-node/packages/edition-node) contains info how to get started within a pure node environment.
32
+
33
+
*[Pattern Lab/Node: Gulp Edition](https://github.com/pattern-lab/patternlab-node/packages/edition-node-gulp) contains info how to get started within a Gulp task running environment.
34
+
45
35
46
36
## Ecosystem
47
37
@@ -51,11 +41,11 @@ Core, and Editions, are part of the [Pattern Lab Ecosystem](http://patternlab.io
51
41
52
42
## Usage
53
43
54
-
`patternlab-node` can be required within any Node environment, taking in a configuration file at instantiation.
44
+
`@pattern-lab/core` can be required within any Node environment, taking in a configuration file at instantiation.
// build, optionally watching or choosing incremental builds
61
51
patternlab.build({
@@ -73,7 +63,7 @@ patternlab.serve({
73
63
74
64
* Read more about the rest of [Public API](./docs), and already implemented for you within [Editions](#editions).
75
65
76
-
* A full-featured [command line interface](https://github.com/pattern-lab/patternlab-node-cli) is also available courtesy of [@raphaelokon](https://github.com/raphaelokon).
66
+
* A full-featured [command line interface](https://github.com/pattern-lab/patternlab-node/packages/cli) is also available.
If you are interested in [contributing to Pattern Lab](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md), it's suggested to install an Edition of your choice and then run a local copy of this repository via [`npm link`](https://docs.npmjs.com/cli/link).
1. how to clone this repository to an arbitrary location
115
-
2. install all dependencies (run `npm install --dev` if your NODE_ENV is production for some reason)
116
-
3. setup the `npm link` to your local copy
117
-
4. use the local copy of patternlab-node in your edition / working directory
118
-
119
-
> Make sure to change to whichever branch you intend to hack on or test within your cloned repository, such as `dev` or `bugfix/fixes-broken-unittest`
120
-
90
+
If you are interested in contributing to Pattern Lab, please do take some time to learn how we [develop locally](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md#developing-locally) within the contribution guidelines.
121
91
## Upgrading
122
92
123
93
If you find yourself here and are looking to upgrade, check out how to upgrade from version to version of Pattern Lab Node here: [https://github.com/pattern-lab/patternlab-node/wiki/Upgrading](https://github.com/pattern-lab/patternlab-node/wiki/Upgrading)
124
94
125
-
View the [ChangeLog](https://github.com/pattern-lab/patternlab-node/wiki/ChangeLog) for the latest Pattern Lab Node updates.
95
+
View the [latest releases](https://github.com/pattern-lab/patternlab-node/releases) for comprehensive changelogs.
126
96
127
97
## Contributing
128
98
129
99
If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
130
100
131
-
Please read the guidelines: https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md
101
+
Please read the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/.github/CONTRIBUTING.md).
0 commit comments