# generator-hedley

> Headless Drupal, Angular app, and Behat framework.

Latest version **1.4.0** (published 2016-07-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-hedley
pnpm add generator-hedley
yarn add generator-hedley
bun add generator-hedley
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2016-07-09 |
| First published | 2014-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 98 |
| Author | Gizra |
| Maintainers | amitaibu |
| Keywords | yeoman-generator, Drupal, RESTful, Behat |

## Links

- npm: https://www.npmjs.com/package/generator-hedley
- Repository: https://github.com/gizra/generator-hedley
- Homepage: https://github.com/gizra/generator-hedley#readme
- Issues: https://github.com/gizra/generator-hedley/issues
- npm.io page: https://npm.io/package/generator-hedley

## Dependencies (8)

- [glob](https://npm.io/package/glob.md) ^4.3.2
- [chalk](https://npm.io/package/chalk.md) ^0.5.0
- [yosay](https://npm.io/package/yosay.md) ^0.3.0
- [process](https://npm.io/package/process.md) ^0.10.0
- [replace](https://npm.io/package/replace.md) ^0.3.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.13.0
- [change-case](https://npm.io/package/change-case.md) ^2.1.6
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^0.18.0

## Recent versions

- 1.4.0 (latest) — 2016-07-09
- 1.3.2 — 2016-03-01
- 1.3.1 — 2016-02-29
- 1.3.0 — 2016-02-29
- 1.2.0 — 2016-02-27
- 1.1.0 — 2016-02-25
- 1.0.0 — 2016-02-23
- 0.2.0 — 2016-02-16
- 0.1.8 — 2015-06-16
- 0.1.7 — 2015-04-15
- 0.1.6 — 2015-01-23
- 0.1.5 — 2015-01-20
- 0.1.4 — 2015-01-01
- 0.1.3 — 2015-01-01
- 0.1.2 — 2015-01-01
- … 3 more at https://npm.io/package/generator-hedley/versions

## README

# generator-hedley [![Build Status](https://travis-ci.org/Gizra/generator-hedley.svg?branch=master)](https://travis-ci.org/Gizra/generator-hedley)

> Scaffold a headless Drupal backend, Angular app client, and Behat tests

Hedley is a [yeoman generator](http://yeoman.io/) that scaffolds a headless Drupal backend, Angular app client, and Behat tests. Its a great starting point for learning and developing fully decoupled websites, that follow _best practices_, and includes automatic testing using Behat.

## Getting Started

### Prerequisites

* Yo (``npm install -g yo``)
* [Drush](https://github.com/drush-ops/drush)
* [Composer](https://getcomposer.org/doc/00-intro.md#globally) installed globally, for Behat dependencies to be setup

### Installation

To install generator-hedley from npm, run:

```bash
npm install -g generator-hedley
```

As we generate not only a Web app but also add behat and other scripts make sure to create a project directory.

```bash
mkdir my-hedley-project
cd my-hedley-project
```

Finally, initiate the generator:

```bash
yo hedley
```

## CLI

You can scaffold a new app with no user interaction, for example:
```
yo hedley --skip-install --project-name=skeleton --github-repo=https://github.com/Foo/skeleton --db=skeleton --db-user=root --db-pass=root --drupal-url=http://localhost/skeleton/www
```

## Pantheon's Could Integration

Integrated into hedley an automated scripts for "Pantheon’s Cloud Integration", The scripts are initiated through `pantheon.yml` and do the following:

* Sanitization for the DEV database when cloned from TEST or LIVE environments (Basically replaces all domains in user's emails to `@test`).
* Revert all features, The [features](https://www.drupal.org/project/features) will be reverted on each deploy to the DEV.
 
You can add or remove operations by editing `pantheon.yml` file in the root of the project.

## Contribute

In order to develop ``generator-hedley`` and provide pull requests the following steps should be taken:

1. Git clone your fork locally.
2. ``npm install`` inside the new directory
3. ``npm link`` - This makes your local system sync with the changes you make
4. ``mkdir skeleton``
5. Inside the new directory, initiate ``yo hedley``, and make sure to keep the default project name to ``skeleton``
6. ``cp sync_hedley.example.sh sync_hedley.sh``
7. Edit ``sync_hedley.sh`` and point the the ``GENERATOR_FOLDER`` variable to the place where ``generator-hedley`` is located
8. From now on, you may easily sync back your changes back to the forked ``generator-hedley`` by executing ``./sync_hedley.sh``

## Credits

[Gizra](https://gizra.com)

## License

MIT

---
_Source: https://npm.io/package/generator-hedley · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._