https://github.com/phase2/generator-pattern-lab-starter
This is a Yeoman Generator for pattern-lab-starter: https://github.com/phase2/pattern-lab-starter
https://github.com/phase2/generator-pattern-lab-starter
Last synced: about 1 year ago
JSON representation
This is a Yeoman Generator for pattern-lab-starter: https://github.com/phase2/pattern-lab-starter
- Host: GitHub
- URL: https://github.com/phase2/generator-pattern-lab-starter
- Owner: phase2
- Created: 2015-04-24T15:03:10.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-12-21T19:04:56.000Z (about 8 years ago)
- Last Synced: 2025-02-16T04:32:31.116Z (about 1 year ago)
- Language: HTML
- Size: 99.6 KB
- Stars: 10
- Watchers: 22
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Generator Pattern Lab Starter
This is a [Yeoman](http://yeoman.io) generator for [Particle](https://github.com/phase2/pattern-lab-starter), a modern design-system driven Drupal theme.
## Install
To install generator-pattern-lab-starter from npm, run:
```bash
npm install -g generator-pattern-lab-starter
```
## Usage
*Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.*
Finally, initiate the generator:
```bash
yo pattern-lab-starter
```
Extras can be installed with:
```bash
yo pattern-lab-starter:extras
```
### Options
* **release**: Run with `--release=` to override the default use of master branch.
## Docker-based Development
You can perform local development of this generator using our Docker integration.
Install the dependencies:
```
docker-compose run --rm cli npm install
```
Then run the generator:
```
docker-compose run --rm yo pattern-lab-starter
```
This will output your code in ~/Projects/newproject. To change this, use the `YO_PROJECT_DIRECTORY` environment variable:
```
YO_PROJECT_DIRECTORY=/opt/development/mytheme docker-compose run --rm yo pattern-lab-starter
```
## Contributor notes
Run eslint against this project by running:
```bash
npm run lint
```