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
Copy file name to clipboardExpand all lines: readme.md
+21-25Lines changed: 21 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,25 +4,6 @@
4
4
# Pattern Lab Node - Webpack Edition
5
5
The webpack wrapper around [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node) providing tasks to interact with the core library and move supporting frontend assets.
6
6
7
-
8
-
9
-
## Quickstart Guide
10
-
*If you do not have nodejs installed, please check the **Prerequisites** section*
3. To populate Patternlab with sample data, install a starter kit
18
-
Run `npm install starterkit-mustache-demo`
19
-
There are other [starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) available
20
-
4. Generate sample files
21
-
Run: `npm run patternlab:loadstarterkit --kit=starterkit-mustache-demo`
22
-
5. Show Patternlab in a Webbrowser
23
-
Run: `npm run patternlab:serve`
24
-
25
-
26
7
## Packaged Components
27
8
28
9
The webpack edition comes with the following components:
@@ -36,6 +17,20 @@ The webpack edition comes with the following components:
36
17
37
18
The Pattern Lab Node - webpack edition uses [Node](https://nodejs.org/en/) for core processing, [npm](https://www.npmjs.com/) to manage project dependencies, and [webpack.io](https://webpack.github.io/) 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.
38
19
20
+
## Quickstart Guide
21
+
_Note: You must have all of the prerequisites first_
22
+
23
+
1. Download the `.zip` or fork this repository, then clone it locally.
1. In a terminal window, navigate to the downloaded directory
26
+
> `cd path/to/patternlab-edition-node-webpack`
27
+
1. To populate Patternlab with sample data, install a starter kit, there are many [starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) choose from
28
+
> `npm install starterkit-mustache-demo`
29
+
1. Generate sample files
30
+
> `npm run patternlab:loadstarterkit --kit=starterkit-mustache-demo`
31
+
1. Show Patternlab in a Webbrowser
32
+
> `npm run patternlab:serve`
33
+
39
34
## Installing
40
35
41
36
`npm install`
@@ -136,7 +131,7 @@ By default merge does a `append` if that option works for you only set which web
136
131
### Licenses
137
132
* [babel-core](https://github.com/babel/babel/blob/master/LICENSE) - MIT
[@rgualberto](https://github.com/rgualberto) | "A huge thank you to a incredible developer [Rodrigo Gualberto](https://github.com/rgualberto) for all of his hard work, dedication, and support from the start of project."
0 commit comments