Sha256: 5c85d87a5f0d11bc4a8f84ebdbf08d79e36c8ce7478872550b6c81611ebbcd8c

Contents?: true

Size: 1.03 KB

Versions: 10

Compression:

Stored size: 1.03 KB

Contents

# Hephaestus

A plug template for Yetto. It serves two purposes:

1. Use this to quickly spin up new plugs with a set of defaults.
2. Hephaestus also exists as an engine, and is responsible for the majority of a plug's Yetto communication logic.

## Usage

First, install Hephaestus _globally_, on your system:

```
gem install hephaestus
```

Then, in the parent directory where you want your plug to be created, run:

```
hephaestus plug-app
```

Where `app` represents the name of the platform you'd like to interact with, like `jira`, `notion`, `slack`, etc.

### Testing locally

If you're working on updating/testing this gem locally, you may also try:

```
rm -rf plug-app && DEBUG=1 bundle exec hephaestus/bin/hephaestus plug-app
```

This way you can wipe the dir and quickly iterate on new changes.

If you're having trouble connecting to the Internet, you can set `HEPHAESTUS_NO_EXTERNAL=1`.

## Acknowledgements

The template generation for this project was heavily based on [thoughtbot/suspenders](https://github.com/thoughtbot/suspenders).

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
hephaestus-0.8.16.1 README.md
hephaestus-0.8.16 README.md
hephaestus-0.8.15.5 README.md
hephaestus-0.8.15.4 README.md
hephaestus-0.8.15.3 README.md
hephaestus-0.8.15.2 README.md
hephaestus-0.8.15.1 README.md
hephaestus-0.8.15 README.md
hephaestus-0.8.14 README.md
hephaestus-0.8.13 README.md