An open API service indexing awesome lists of open source software.

https://github.com/tinchorocks/spree_contact_tools

Contact tools (Contact & Newsletter modules) for Spree Ecommerce
https://github.com/tinchorocks/spree_contact_tools

contact-form newsletter-modules recaptcha ruby-on-rails spree-ecommerce spree-extension

Last synced: about 2 months ago
JSON representation

Contact tools (Contact & Newsletter modules) for Spree Ecommerce

Awesome Lists containing this project

README

        

# SpreeContactTools

Provides Contact & Newsletter modules with Recaptcha integration for Spree Ecommerce v4.0.
English and Spanish translations support.

Find example images [here](IMAGES.md).
Available documentation [here](DOCUMENTATION.md).

## Installation

1. Add this extension to your Gemfile with this line:
```ruby
gem 'spree_contact_tools', github: 'Tinchorocks/spree_contact_tools'
```

2. Install the gem using Bundler:
```ruby
bundle install
```

3. Copy & run migrations
```ruby
bundle exec rails g spree_contact_tools:install
```

4. Restart your server

If your server was running, restart it so that it can find the assets properly.

## Testing

First bundle your dependencies, then run `rake`. `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 `rake test_app`.

```shell
bundle
bundle exec rake
```

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

```ruby
require 'spree_contact_tools/factories'
```

## To Do

* [ ] Add unit tests.

## Contributing

If you'd like to contribute, please take a look at the
[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
pull request.

Copyright (c) 2019 Tinchorocks, released under the New BSD License