Skip to content

deakee/loyalty

Repository files navigation

Deakee Loyalty

Free, open-source loyalty implementations for the Deakee partner ecosystem.

⚠️ Architecture transition (2026-05-11) — these plugins are mid-pivot from the old OAuth2-server-in-plugin model to the new two-layer model described in the Plugin Integration Standard. The spec docs in docs/ are current. The plugin code under plugins/ is still the previous design; rewrites are in progress. Use the docs as the source of truth, not the code.

Three-tier ecosystem

Tier Brand profile How they connect Exchange access
1a — Bespoke display-only Famous brands (Nike, Starbucks, Sam's, AAdvantage) Custom OAuth2 read-only adapter ❌ View only
1b — Platform adapter display-only Brands on Yotpo / Smile.io / LoyaltyLion / Klaviyo One Deakee adapter per platform ❌ View only
2 — Full Deakee partner Mid-size brands willing to integrate fully Plugin (WooCommerce, Magento, Shopify, …) + ERC-8063 bridge ✅ Full access

Tier 1 makes Deakee a loyalty aggregator (Plaid-style): users see balances from Nike, Starbucks, every Yotpo brand in one app. Read-only. The points stay in the brand's own system.

Tier 2 makes Deakee a loyalty infrastructure provider (Stripe-style): the plugin is a full centralized loyalty program (earn on purchase, redeem at checkout — all in the partner's own DB) plus a bridge layer that lets the customer voluntarily mint their centralized points into on-chain ERC-8063 tokens for cross-brand trading.

The chain only enters on user-initiated bridge operations. Mint never fires on every purchase — purchase is a private event inside the partner's app.

Packages

Path What it is Status
packages/core Shared TS: relayer client, identity OAuth2, voucher verify, ABI helpers. Currently the old OAuth2-server code — rewrite in progress. rewriting
packages/sdk @deakee/loyalty-sdk — npm-published subset for custom integrators rewriting
packages/dashboard Shared React admin components (Tier 2 dashboard) planned
packages/adapters Tier 1 adapters (Yotpo, Smile.io, LoyaltyLion, NikePlus, …) planned

Tier 2 plugins

Path Platform Status
plugins/starter Next.js standalone e-commerce starter rewriting
plugins/woocommerce WordPress + WooCommerce rewriting
plugins/laravel Laravel 10+ rewriting
plugins/magento2 Magento 2 CE/EE rewriting
plugins/opencart OpenCart 3.x / 4.x rewriting
plugins/shopify Shopify App Store rewriting
plugins/prestashop PrestaShop 1.7+ rewriting
plugins/bigcommerce BigCommerce App Marketplace rewriting

Documentation

Read in this order:

  1. docs/FEATURE_OVERVIEW.md — three-tier overview, architecture
  2. docs/PLUGIN_INTEGRATION_STANDARD.md — the Tier 2 contract: centralized + bridge
  3. docs/DISPLAY_ONLY_INTEGRATION.md — Tier 1 (aggregator) contract
  4. docs/POINT_ISSUANCE_MODEL.md — earn (centralized) + bridge mechanics
  5. docs/PLATFORM_PLUGINS.md — per-platform details
  6. docs/CROSS_BRAND_NETWORK.md — the CEX (Tier 2 tokens only)
  7. docs/HOSTED_SERVICE.md — managed option for no-platform partners
  8. docs/PARTNER_DASHBOARD.md — admin UI spec
  9. docs/SELF_SERVE_ONBOARDING.md — partner wizard

License

MIT. See LICENSE.

About

Deakee Loyalty APPs

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors