Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 1.91 KB

README.md

File metadata and controls

76 lines (47 loc) · 1.91 KB

Solidus Reviews

CircleCI

Straightforward review/rating functionality, updated for Solidus.

While the gem's name has changed, the module namespace and commands are still spree for now.

Installation

Add the following to your Gemfile to install from git:

gem 'solidus_reviews', github: 'solidusio-contrib/solidus_reviews'

Now bundle up with:

$ bundle

Next, run the rake task that copies the necessary migrations and assets to your project:

$ rails g solidus_reviews:install

And finish with a migrate:

$ rake db:migrate

Now you should be able to boot up your server with:

$ rails s

That's all!

Usage

The Spree::ReviewsController controller provides all the CRUD functionality for product reviews.

The Spree::FeedbackReviewsController allows user to express their feedback on a specific review. You can think of these as meta-reviews (e.g. the classic "Was this useful?" modal).

You can approve, edit and delete reviews and feedback reviews from the backend.

Factories

If you want factories for our models available in your application, simply require our factories in your spec_helper.rb:

require 'solidus_reviews/factories'

Testing

Just run the following to automatically build a dummy app if necessary and run the tests:

$ bundle exec rake

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio-contrib/solidus_reviews.

License

Copyright (c) 2009-2019 Solidus and contributors, released under the New BSD License.