Skip to content

Send an email alert for when a product variant returns back in stock

License

Notifications You must be signed in to change notification settings

watg/solidus_back_in_stock

Repository files navigation

Solidus Back In Stock

CircleCI

Add a route for back in stock notification subscriptions to be collected from the FE (TODO example will be provided). These are saved in a list visible here: /admin/back_in_stock_notifications. A Sidekiq job is then used to check for when items are back in stock and send out an email notification via Mandrill.

Installation

Add solidus_back_in_stock to your Gemfile:

gem 'solidus_back_in_stock'

Bundle your dependencies and run the installation generator:

bin/rails generate solidus_back_in_stock:install

Usage

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.

bin/rake

To run Rubocop static code analysis run

bundle exec rubocop

When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec_helper:

require 'solidus_back_in_stock/factories'

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

Updating the changelog

Before and after releases the changelog should be updated to reflect the up-to-date status of the project:

bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"

Releasing new versions

Please refer to the dedicated page on Solidus wiki.

License

Copyright (c) 2021 Christopher Reeve, released under the New BSD License.