Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sungwoncho/feedy
Rails engine to collect and view user feedback
https://github.com/sungwoncho/feedy
Last synced: 15 days ago
JSON representation
Rails engine to collect and view user feedback
- Host: GitHub
- URL: https://github.com/sungwoncho/feedy
- Owner: sungwoncho
- License: mit
- Created: 2015-02-06T01:52:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-02-08T10:31:40.000Z (almost 10 years ago)
- Last Synced: 2024-04-24T13:17:51.983Z (8 months ago)
- Language: Ruby
- Homepage: https://feedy-demo.herokuapp.com/
- Size: 383 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Feedy [](https://travis-ci.org/sungwoncho/feedy)
Feedy is an engine that lets you collect and view user feedback with no hassle.
Embed feedy in your view, and users will see a feedback button they can toggle in the bottom-right corner of the browser screen.
## Working demo
[Demo](https://feedy-demo.herokuapp.com/)
## Installation
Include Feedy in your Gemfile:
```ruby
gem 'feedy'
```
Run `bundle install` to install the gem.
Now run the generator:
```
rails g feedy:install
```
The generator will copy migrations, and create an initializer at `config/initializers/feedy.rb`, and mount the engine in your `config/routes.rb` file.
Run the migration:
```
rake db:migrate
```
Now, require CSS and JavaScript assets to your asset pipeline.
*application.css*
```
...
*= require feedy/feedbacks
```
*application.js*
```
...
//= require jquery
//= require jquery-ujs
//= require feedy/feedbacks
```
Require the JavaScript asset *after* `jquery`, and `jquery-ujs`, as Feedy depends on them.
## Usage
In any of your views where you want to include feedback button, just include the following:
```
<%= feedy_feedback %>
```
To view the submitted feedbacks, go to `/feedy/feedbacks` path in your browser.
## Configuration
`config/initializers/feedy.rb` holds configuration values.
Change them to customize the engine's behavior. Don't forget to restart your server after making any changes.
## Contributing
Pull requests and issues are welcomed.
### Future roadmap and todos
* Add authentication for feedback views
* Paginate the feedbacks
* Customizable feedback inputs