https://github.com/upsidelab/spree_gladly
Official Gladly integration for Spree Commerce
https://github.com/upsidelab/spree_gladly
customersupport ecommerce ruby
Last synced: 3 months ago
JSON representation
Official Gladly integration for Spree Commerce
- Host: GitHub
- URL: https://github.com/upsidelab/spree_gladly
- Owner: upsidelab
- License: bsd-3-clause
- Created: 2021-05-17T07:44:35.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T14:32:42.000Z (over 2 years ago)
- Last Synced: 2024-03-20T02:53:08.550Z (about 2 years ago)
- Topics: customersupport, ecommerce, ruby
- Language: Ruby
- Homepage: https://docs.upsidelab.io/spree-gladly
- Size: 1.34 MB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Official Gladly integration for Spree Commerce. Works with:
&message=3.0%20|%203.1%20|%203.7%20|%204.0%20|%204.1%20|%204.2&style=flat&labelColor=fb6925&color=fb7c40)
This extension allows you to connect your [Spree](https://github.com/spree/spree) store with [Gladly](https://www.gladly.com/) customer service platform. It allows Gladly agents to see information about Spree customers, their orders and events associated with them.
You can read more about the connector in [Gladly help docs](https://help.gladly.com/docs/spree-overview).
## Table of contents
- [Table of contents](#table-of-contents)
- [Getting started](#getting-started)
- [Configuration](#configuration)
- [Usage](#usage)
- [Setup sandbox environment](#setup-sandbox-environment)
- [Customization](#customization)
- [Testing](#testing)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Contributing Guide](#contributing-guide)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Getting started
>NOTE: Make sure you're using one of supported Spree versions: `3.0`, `3.1`, `3.7`, `4.0`, `4.1`, `4.2`
1. Add 'spree_gladly' gem to your application's Gemfile
```ruby
gem 'spree_gladly'
```
2. Install the bundle
```bash
$ bundle install
```
3. Run the installer
```bash
$ bundle exec rails generate spree_gladly:install
```
4. Done!
## Configuration
- [Configuring Spree Store](https://docs.upsidelab.io/spree-gladly/configuration/spree-store.html)
- [Configuring Gladly](https://docs.upsidelab.io/spree-gladly/configuration/gladly.html)
## Usage
To understand how the extension works from user's point of view please refer to the [Gladly help docs](https://help.gladly.com/docs/spree-overview).
The implementation adheres to the specification of a Gladly Lookup adapter as described [here](https://developer.gladly.com/tutorials/lookup). The below description will assume that the reader has familiarized themselves with the tutorial.
- [Basic lookup](https://docs.upsidelab.io/spree-gladly/usage/basic-lookup.html)
- [Manual Search Request](https://docs.upsidelab.io/spree-gladly/usage/basic-lookup.html#manual-search-request)
- [Automatic Search Request](https://docs.upsidelab.io/spree-gladly/usage/basic-lookup.html#automatic-search-request)
- [Basic Lookup Response](https://docs.upsidelab.io/spree-gladly/usage/basic-lookup.html#basic-lookup-response)
- [Detailed lookup](https://docs.upsidelab.io/spree-gladly/usage/detailed-lookup.html)
- [How does the search work? What do the fields mean?](https://docs.upsidelab.io/spree-gladly/usage/search.html)
- [Basic search](https://docs.upsidelab.io/spree-gladly/usage/search.html#basic-search)
- [Detailed search](https://docs.upsidelab.io/spree-gladly/usage/search.html#detailed-search)
- [Events](https://docs.upsidelab.io/spree-gladly/usage/events.html)
## Setup sandbox environment
[Learn how to setup the sandbox environment](https://docs.upsidelab.io/spree-gladly/sandbox-environment.html).
## Customization
Within spree_gladly gem we distinguish response for guest and registered customer.
For customizing detailed lookup response and more [read the customization docs](https://docs.upsidelab.io/spree-gladly/customization.html).
## Testing
[Learn how to test the integration](https://docs.upsidelab.io/spree-gladly/testing.html).
## Documentation
Learn more about using Spree Gladly
- [Guides](https://docs.upsidelab.io/spree-gladly/)
- [Configuring](https://docs.upsidelab.io/spree-gladly/configuration/spree-store.html)
- [Usage](https://docs.upsidelab.io/spree-gladly/usage/basic-lookup.html)
- [Customization](https://docs.upsidelab.io/spree-gladly/customization.html)
## Contributing
We're glad for your interest in Spree Gladly and taking the time to contribute 🧡
### [Contributing Guide](./.github/CONTRIBUTING.md)
Read our [Contributing Guide](./.github/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to the project.
### [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
Everyone interacting in the SpreeGladly project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [Code of Conduct](./.github/CODE_OF_CONDUCT.md).
## License
Spree Gladly is [BSD 3-Clause "New" or "Revised" licensed](/LICENSE).
---
This repository is being developed and maintained by:
