Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/papakvy/chatworkify

Bring Chatwork notification into your Application ^^
https://github.com/papakvy/chatworkify

capistrano-plugin chatwork chatworkify ruby rubygem

Last synced: about 2 months ago
JSON representation

Bring Chatwork notification into your Application ^^

Host: GitHub
URL: https://github.com/papakvy/chatworkify
Owner: papakvy
License: mit
Created: 2021-10-22T10:33:21.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-05-10T08:07:21.000Z (8 months ago)
Last Synced: 2024-10-14T00:23:13.176Z (2 months ago)
Topics: capistrano-plugin, chatwork, chatworkify, ruby, rubygem
Language: Ruby
Homepage:
Size: 34.2 KB
Stars: 6
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Chatworkify

![Gem](https://img.shields.io/gem/v/chatworkify?color=%234cc61f&label=Gem%20version&logo=ruby&logoColor=red)
![Gem](https://img.shields.io/gem/dt/chatworkify?color=%2330c754&label=Downloads&logo=rubygems&logoColor=red)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rs-phunt/chatworkify/Tests%20%F0%9F%A7%AA?label=Tests&logo=github)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/rs-phunt/chatworkify/Rubocop%20Lint?label=Rubocop&logo=github)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'chatworkify', require: false
```

And then execute:

$ bundle install

Or install it yourself as:

$ gem install chatworkify

## Usage

Require the gem in your `Capfile`:

require 'capistrano/chatworkify'

## Configuration

### Puts `CHATWORK_API_TOKEN` into your ENV

- Export to your `bash`: `export CHATWORK_API_TOKEN=xxx`

- Add to `.env` if you're using `dotenv` gem

### Puts `CHATWORK_ROOM_ID` into your ENV or custom in `config/deploy`

```ruby
# config/deploy.rb
...
set :chatwork_room_id, 'xxx'
...
```