Programs is a monorepo containing the packages necessary to integrate Usher's partner programs & data collection technology into a new dApp or software environment. These features include:
- Authentication
- Link sharing over decentralised data
- Wallet connections
- Affiliate marketing campaigns with crypto rewards
Project Status:
Usher is live and ready to accept newly created campaigns whereby rewards can be distributed to partners that refer people to the campaign's configured destination URL. Campaigns can also include reference to Smart Contract events, whereby wallets can be connected upon invite link visits, and then tracked as referred users when their associated wallet triggers a tracked Smart Contract events.Upcoming changes:
Usher is preparing a new release where the link sharing and conversion tracking features can also be used purely for data collection and insights. While affiliate marketing rewards can still be associated to conversions, Usher is evolving the user expeirence to offer value through insights.
| Name | Package | Description |
|---|---|---|
| Auth | @usher.so/auth | Produce an authenticated DID using a wallet connection like Metamask, ArConnect, etc. and interface with the Ceramic Network or Usher's APIs |
| Campaigns | @usher.so/campaigns | Create your own Usher Campaigns directly within your dApp |
| Partnerships | @usher.so/partnerships | Manage your users' partnerships against one or more Campaigns |
| Shared | @usher.so/shared | A package of facets shared throughout the Usher codebase. |
| CLI | @usher.so/cli | Manage your Usher Campaigns directly from your Terminal |
To learn more about each individual package, navigate to the relevant package folder.
Learn the basics by creating a new Camapign and indexing it on Usher with the Usher CLI. CLI guide →
Full documentation on installation and usage can be found on the Usher documentation site →
- For Typescript docs: https://ts-docs.programs.usher.so
- For questions, support, and discussions: Join the Usher Discord
- For bugs and feature requests: Create an issue on Github
We are happy to accept small and large contributions, feel free to make a suggestion or submit a pull request.
This monorepo is managed with Nx.
Run yarn build or npx nx build <package_name> to build the library.
- rsoury (@rsoury)
- victorshevtsov (@victorshevtsov)
Fully open source and licensed under MIT.