AlexWayfer/flame_deploy_toys

# Flame Deploy Toys

[![Gem](https://img.shields.io/gem/v/flame_deploy_toys.svg?style=flat-square)](https://rubygems.org/gems/flame_deploy_toys)
[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/flame_deploy_toys?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/flame_deploy_toys)
[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/flame_deploy_toys/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/flame_deploy_toys)
[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/flame_deploy_toys.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/flame_deploy_toys)
[![Depfu](https://img.shields.io/depfu/AlexWayfer/benchmark_toys?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/flame_deploy_toys)
[![Inline docs](https://inch-ci.org/github/AlexWayfer/flame_deploy_toys.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/flame_deploy_toys)
[![License](https://img.shields.io/github/license/AlexWayfer/flame_deploy_toys.svg?style=flat-square)](LICENSE.txt)

Toys template for deploying [Flame](https://github.com/AlexWayfer/flame)
application.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'flame_deploy_toys'
```

And then execute:

```shell
bundle install
```

Or install it yourself as:

```shell
gem install flame_deploy_toys
```

## Usage

```ruby
## .toys/.toys.rb
require 'flame_deploy_toys'
expand FlameDeployToys::Template, config_dir: "#{__dir__}/../config"
```

Then it will look for `deploy.yaml` file in config directory with such structure:

```yaml
- :ssh: 'server alias from ~/.ssh/config (or user@host)'
  :path: '/path/to/root/of/project'
```

## Development

After checking out the repo, run `bundle install` to install dependencies.

Then, run `toys rspec` to run the tests.

To install this gem onto your local machine, run `toys gem install`.

To release a new version, run `toys gem release %version%`.
See how it works [here](https://github.com/AlexWayfer/gem_toys#release).

## Contributing

Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/flame_deploy_toys).

## License

The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT).