Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/russellsteadman/affiliate
Add affiliation tags to links automatically in the browser
https://github.com/russellsteadman/affiliate
ads advertising affiliate affiliate-links affiliates amazon dom javascript link marketing referral
Last synced: about 2 months ago
JSON representation
Add affiliation tags to links automatically in the browser
- Host: GitHub
- URL: https://github.com/russellsteadman/affiliate
- Owner: russellsteadman
- License: mit
- Created: 2018-01-01T17:26:48.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T09:49:37.000Z (almost 2 years ago)
- Last Synced: 2024-10-17T03:36:54.969Z (4 months ago)
- Topics: ads, advertising, affiliate, affiliate-links, affiliates, amazon, dom, javascript, link, marketing, referral
- Language: TypeScript
- Homepage: https://affiliate.js.org/
- Size: 1.78 MB
- Stars: 109
- Watchers: 6
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Affiliate
Affiliate is a platform agnostic link affiliator. Simplify affiliating links with automatic affiliation in the browser. Affiliate works with libraries that mutate the DOM after the page loads, including React.
[](https://github.com/russellsteadman/affiliate) [](https://www.npmjs.com/package/affiliate) [](https://www.jsdelivr.com/package/npm/affiliate) [](https://bundlephobia.com/result?p=affiliate) [](https://bundlephobia.com/result?p=affiliate)
## Installation
Use NPM or Yarn
```bash
$ npm install affiliate
$ yarn add affiliate
```
Or use a CDN ([check out the codeless setup](#blogs-and-related-sites))
```html
```
The precompiled version of `affiliate@5` supports modern browsers (i.e. `ES2016` or above) by default.
## What It Can Do
Affiliate can modify query tags (e.g. setting `?tag=my-tag`, which is the most common method for affiliate tags), modify URL paths, and modify host names.
```html
Original
```
```html
New Query Tags
Modified URL Path
Modified Host Name
```
Affiliate has easy [plugins](https://affiliate.js.org/plugins), including one for [Amazon](https://affiliate.js.org/plugins/amazon), which simplify adding affiliate links even more.
## Basic Setup
Read **[the documentation](https://affiliate.js.org/)** for more advanced usage.
```js
import Affiliate from 'affiliate';
const aff = Affiliate.create({
tags: [
{
hosts: ['example.com', 'www.example.com'],
query: {
ref: 'my-tag', // This means ?ref=my-tag
},
},
{
hosts: ['example.org', 'shop.example.org'],
query: {
tag: 'my-tag2', // This means ?tag=my-tag2
},
},
],
});
aff.attach();
```
## Documentation
Affiliate is simple and quick to set up, even for more complex usage. Read the docs at: **[affiliate.js.org](https://affiliate.js.org/)**.
## Blogs and Related Sites
A simplified codeless solution might better suit some sites that use content module systems, such as WordPress, SquareSpace, etc.
Insert this code within the HTML `...` tag. The contents of the `data-auto-affiliate` attribute will tell Affiliate what to do.
```html
```
### data-auto-affiliate Syntax
The syntax for data-auto-affiliate is capital `WHERE`, a comma separated list of domains, capital `SET`, and then comma separated list of URL queries in the format `key=value`. Multiple website groups can be separated by a capital `AND`.
```sql
WHERE amazon.com, www.amazon.com SET tag = MY-AMAZON-TAG AND WHERE example.com, shop.example.com SET ref = MY-OTHER-TAG
```
## Left with Questions?
If for any reason you feel that this documentation is unclear or incomplete, [add an issue](https://github.com/russellsteadman/affiliate/issues/new) detailing what needs to be improved.
## Star This Project
Like this project? Let me know by [putting a star on it](https://github.com/russellsteadman/affiliate). 😉🌟
## License
MIT (C) [Russell Steadman](https://www.russellsteadman.com/?utm_source=aff_repo&utm_medium=readme_copy). Learn more in the [LICENSE](https://github.com/russellsteadman/affiliate/blob/main/LICENSE) file.