https://github.com/zenizh/meyasubako

Easy to install opinion box for Rails application.
https://github.com/zenizh/meyasubako

Last synced: about 1 month ago
JSON representation

Easy to install opinion box for Rails application.

• Host: GitHub
• URL: https://github.com/zenizh/meyasubako
• Owner: zenizh
• License: mit
• Created: 2015-01-26T03:08:12.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-02-17T13:17:20.000Z (almost 9 years ago)
• Last Synced: 2024-10-28T13:36:03.138Z (about 2 months ago)
• Language: Ruby
• Homepage: https://rubygems.org/gems/meyasubako
• Size: 719 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# Meyasubako

[![Build Status](https://travis-ci.org/kami-zh/meyasubako.svg)](https://travis-ci.org/kami-zh/meyasubako)

[![Gem Version](https://badge.fury.io/rb/meyasubako.svg)](http://badge.fury.io/rb/meyasubako)

Meyasubako provides easy to install opinion box for Rails application.

The submitted opinion is sent by ActionMailer.

Please look at following demo.

Meyasubako (目安箱) is "Opinion Box" in Japanese.

## Demo

![](doc/demo.gif)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'meyasubako'

```

And then execute:

```

$ bundle

```

## Usage

At first, you have to add `require` to your asset files.

In `app/assets/javascripts/application.js`:

```js

//= require meyasubako

```

In `app/assets/stylesheets/application.css`:

```css

/*

 *= require meyasubako

 */

```

Then, you can render opinion box using `render_meyasubako` method where you like in views.

```erb

<%= render_meyasubako %>

```

## Configuration

You can configure email's `to` and `from`.

To do this, create `config/initializers/meyasubako.rb` and add this lines:

```ruby

Meyasubako.configure do |config|

  config.to   = '[email protected]'

  config.from = '[email protected]'

end

```

## Customize

If you want to customize the theme color, set `$meyasubako-color` to your `app/assets/stylesheets/application.scss` like this:

```scss

/*

 *= require_tree .

 *= require_self

 */

$meyasubako-color: #ffa933;

@import 'meyasubako';

```

![](doc/screenshot.png)

## Languages

Following languages are available.

If you want to add additional language, please send pull request :)

- [English](config/locales/en.yml)

- [Japanese](config/locales/ja.yml)

## Contributing

1. Fork it ( https://github.com/kami-zh/meyasubako/fork )

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request