{"id":19157109,"url":"https://github.com/kinduff/spree_reffiliate","last_synced_at":"2025-05-08T21:13:28.768Z","repository":{"id":20574345,"uuid":"23854789","full_name":"kinduff/spree_reffiliate","owner":"kinduff","description":"Spree Affiliate and Referrals extension","archived":false,"fork":false,"pushed_at":"2017-09-05T18:24:46.000Z","size":82,"stargazers_count":24,"open_issues_count":0,"forks_count":80,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-05-08T21:12:54.067Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kinduff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-10T00:18:06.000Z","updated_at":"2024-05-24T12:41:28.000Z","dependencies_parsed_at":"2022-09-11T01:10:21.113Z","dependency_job_id":null,"html_url":"https://github.com/kinduff/spree_reffiliate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kinduff%2Fspree_reffiliate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kinduff%2Fspree_reffiliate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kinduff%2Fspree_reffiliate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kinduff%2Fspree_reffiliate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kinduff","download_url":"https://codeload.github.com/kinduff/spree_reffiliate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253149617,"owners_count":21861739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T08:38:22.143Z","updated_at":"2025-05-08T21:13:28.742Z","avatar_url":"https://github.com/kinduff.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":" ## :warning: This repository is no longer maintained by the original author :warning:\n ## :warning: Please refer to [vinsol-spree-contrib/spree_reffiliate](https://github.com/vinsol-spree-contrib/spree_reffiliate) for an updated version :warning:\n\nSpree Reffiliate\n================\n\n[![Codeship Status for kinduff/spree_reffiliate](https://codeship.com/projects/ab504f70-4b22-0132-8f9f-22e1dbe6882e/status)](https://codeship.com/projects/46636)\n[![Build Status](https://travis-ci.org/kinduff/spree_reffiliate.svg?branch=master)](https://travis-ci.org/kinduff/spree_reffiliate)\n[![Code Climate](https://codeclimate.com/github/kinduff/spree_reffiliate/badges/gpa.svg)](https://codeclimate.com/github/kinduff/spree_reffiliate)\n[![Test Coverage](https://codeclimate.com/github/kinduff/spree_reffiliate/badges/coverage.svg)](https://codeclimate.com/github/kinduff/spree_reffiliate)\n\nSpree Reffiliate is a [Spree] Extension that adds the referral and affiliate features to your Spree Store. Users are going to be able to share a unique hyperlink with their friends to gain benefits and you'll be able to create affiliate campaigns through the Spree Administrator and configure it to your needs.\n\n### Referrals\n+ User can share a unique URL\n+ User can signup as a referred user\n+ Referred user can have promotions\n+ Admin is able to see referred users and orders from user\n\n### Affiliates\n+ Admin is able to create an affiliate with a custom path\n+ Customize the affiliate view with a partial\n+ Users are going to be able to signup as an affiliated user\n+ Affiliated user can have individual promotions\n+ Admin is able to see affiliated users and orders from affiliate\n\n![Spree Reffiliate](https://cloud.githubusercontent.com/assets/1270156/4210980/11c6ba84-387f-11e4-8f3d-4eb7f45f9004.png)\n\n## Installation\n\nTo use the stable branch, add this line to your Gemfile:\n\n```ruby\ngem 'spree_reffiliate'\n```\n\nAlternatively, if you want to use the bleeding edge version, use this line:\n\n```ruby\ngem 'spree_reffiliate', github: 'kinduff/spree_reffiliate'\n```\n\nBundle your dependencies and run the installation generator:\n\n```shell\nbundle\nbundle exec rails g spree_reffiliate:install\n```\n\n### Existing Users\nIf you already have users within your database, you'll need to run the following command to generate the referral registry for your users:\n\n```shell\nbundle exec rake reffiliate:generate\n```\n\n## Usage\n\nReferral path is `/r/:code` and Affiliate path (assigned in the admin) is `/a/:path`\n\nOnce installed, you'll be able to access the following methods.\n\n#### Spree::User\n+ referred_by =\u003e user record\n+ referral_count =\u003e user count\n+ referred? =\u003e boolean\n+ affiliate? =\u003e boolean\n+ affiliate =\u003e affiliate record\n+ referral =\u003e referral record\n\n#### Spree::Referral\n+ code =\u003e referral code\n+ referred_users =\u003e array of users\n+ referred_orders =\u003e array of orders\n+ referred_count =\u003e user count\n+ referral_activated_users =\u003e users with completed orders\n\n#### Spree::Affiliates\n+ referred_users =\u003e array of users\n+ referred_orders =\u003e array of orders\n+ referred_count =\u003e user count\n\n### Spree Admin\n\n#### Users\n![User Listing](https://cloud.githubusercontent.com/assets/1270156/4210981/11cd353a-387f-11e4-826d-07b272bb249a.png)\n\n#### Affiliates\n![Referral Listing](https://cloud.githubusercontent.com/assets/1270156/4210982/11e9966c-387f-11e4-9a27-fca70c7a706d.png)\n\n#### Promotion Rules\n\n**Important**: in both referrals and affiliates, do **not** fill in the promotion code for the promotion itself to be applied automatically to the user's order. If you add a promotion code, the user will need to apply the for promotion manually.\n\n##### For referrals\n\n![Referral Rules](https://cloud.githubusercontent.com/assets/1270156/4244240/ec3dac8c-3a1d-11e4-8c6d-42c9f9b31e5f.png)\n\n##### For affiliates\n\n![Affiliate Rules](https://cloud.githubusercontent.com/assets/1270156/4244241/ec3e156e-3a1d-11e4-972a-5d61ebf0f053.png)\n\n### User account\n![User account](https://cloud.githubusercontent.com/assets/1270156/4210983/11e9b9a8-387f-11e4-8733-182bdebc449c.png)\n\n## Testing\n\nFirst 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`.\n\n```shell\nbundle\nbundle exec rake\n```\n\nWhen testing your applications integration with this extension you may use it's factories.\nSimply add this require statement to your spec_helper:\n\n```ruby\nrequire 'spree_reffiliate/factories'\n```\n\n## ToDo\n+ Add missing documentation\n+ Add 2-2-stable and 2-1-stable support (or at least test them)\n+ Improve affiliates admin\n+ Improve User and Orders listing at user admin\n+ Add option or helper to show referral code to the user\n\nCopyright (c) 2014 Alejandro AR, released under the New BSD License\n\n[Spree]: http://spreecommerce.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkinduff%2Fspree_reffiliate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkinduff%2Fspree_reffiliate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkinduff%2Fspree_reffiliate/lists"}