https://github.com/solidusio-contrib/solidus_reviews
Product review/rating functionality for your Solidus store.
https://github.com/solidusio-contrib/solidus_reviews
rating rating-functionality review reviews solidus
Last synced: 5 months ago
JSON representation
Product review/rating functionality for your Solidus store.
- Host: GitHub
- URL: https://github.com/solidusio-contrib/solidus_reviews
- Owner: solidusio-contrib
- License: bsd-3-clause
- Created: 2016-07-27T17:36:14.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T10:10:59.000Z (7 months ago)
- Last Synced: 2025-04-12T10:58:08.421Z (6 months ago)
- Topics: rating, rating-functionality, review, reviews, solidus
- Language: Ruby
- Homepage:
- Size: 705 KB
- Stars: 20
- Watchers: 8
- Forks: 51
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Solidus Reviews
[](https://github.com/solidusio-contrib/solidus_reviews/actions/workflows/test.yml)
[](https://codecov.io/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 solidus_reviews to your Gemfile:
```ruby
gem 'solidus_reviews'
```
Bundle your dependencies and run the installation generator:
```shell
bin/rails generate solidus_reviews:install
```
## 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.
## Development
### Testing the extension
First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
app if it does not exist, then it will run specs. The dummy app can be regenerated by using
`bin/rake extension:test_app`.
```shell
bin/rake
```
To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
```shell
bundle exec rubocop
```
When testing your application's integration with this extension you may use its factories.
You can load Solidus core factories along with this extension's factories using this statement:
```ruby
SolidusDevSupport::TestingSupport::Factories.load_for(SolidusReviews::Engine)
```
### Running the sandbox
To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
`sandbox/bin/rails`.
Here's an example:
```
$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop
```
### Releasing new versions
Please refer to the [dedicated page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) in the Solidus wiki.
## License
Copyright (c) 2023 Solidus Contrib, released under the New BSD License.