Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pattern-lab/edition-node-gulp
ARCHIVED - The gulp wrapper around patternlab-node core, providing tasks to interact with the core library and move supporting frontend assets.
https://github.com/pattern-lab/edition-node-gulp
design-systems edition gulp nodejs pattern-lab
Last synced: 3 months ago
JSON representation
ARCHIVED - The gulp wrapper around patternlab-node core, providing tasks to interact with the core library and move supporting frontend assets.
- Host: GitHub
- URL: https://github.com/pattern-lab/edition-node-gulp
- Owner: pattern-lab
- License: mit
- Archived: true
- Created: 2016-03-27T03:35:03.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-10T06:09:58.000Z (about 5 years ago)
- Last Synced: 2024-09-25T08:04:20.820Z (3 months ago)
- Topics: design-systems, edition, gulp, nodejs, pattern-lab
- Language: JavaScript
- Homepage:
- Size: 1.03 MB
- Stars: 279
- Watchers: 22
- Forks: 111
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[📢 Archived in favor of https://github.com/pattern-lab/patternlab-node](https://github.com/pattern-lab/patternlab-node)
# Pattern Lab Node - Gulp Edition
The Gulp wrapper around [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node), the default PatternEngine, and supporting frontend assets.
## Packaged Components
This Edition comes with the following components:
* `pattern-lab/patternlab-node`: [GitHub](https://github.com/pattern-lab/patternlab-node) | [npm](https://www.npmjs.com/package/@pattern-lab/patternlab-node)
* `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)
* `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)
* `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)
## Prerequisites
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.
## Installing
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).
As an Edition, the simplist installation sequence is to clone this repository.
``` bash
mkdir newApp && cd newApp
git clone https://github.com/pattern-lab/edition-node-gulp.git
npm install
```
## Getting Started
This edition comes pre-packaged with a couple simple gulp tasks. Extend them as needed.
**build** patterns, copy assets, and construct ui
``` bash
gulp patternlab:build
```
build patterns, copy assets, and construct ui, watch source files, and **serve** locally
``` bash
gulp patternlab:serve
```
logs Pattern Lab Node usage and **help** content
``` bash
gulp patternlab:help
```
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).
## Updating Pattern Lab
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.