Sha256: eb8e1f8b53a96b59b0646e42212e3a8e0226f1d24bac2b08d71505043222ef2a

Contents?: true

Size: 1.91 KB

Versions: 3

Compression:

Stored size: 1.91 KB

Contents

# Solidus Reviews

[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_reviews.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_reviews)

Straightforward review/rating functionality, updated for [Solidus](https://solidus.io).

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:

```ruby
gem 'solidus_reviews', github: 'solidusio-contrib/solidus_reviews'
```
Now bundle up with:

```console
$ bundle
```

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

```console
$ rails g solidus_reviews:install
```


And finish with a migrate:

```console
$ rake db:migrate
```

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

```console
$ 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`:

```ruby
require 'solidus_reviews/factories'
```

## Testing

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

```shell
$ 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](https://github.com/solidusio) and [contributors](https://github.com/solidusio-contrib/solidus_reviews/graphs/contributors),
released under the [New BSD License](https://github.com/solidusio-contrib/solidus_reviews/blob/master/LICENSE.md).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
solidus_reviews-1.4.1 README.md
solidus_reviews-1.4.0 README.md
solidus_reviews-1.3.0 README.md