@0xernesto/web3-subscription-widget

Subscription Widget for Unlock Protocol

Overview

The @0xernesto/web3-subscription-widget is a React library to facilitate integration with Unlock Protocol subscriptions.

This project was built during the 2023 ETHGlobal New York hackathon.

Installation

Install the widgets library via npm or yarn.

npm i --save @0xernesto/web3-subscription-widget

or

yarn add @0xernesto/web3-subscription-widget

Required Configuration

Optional Configuration

Usage Example

This snippet demonstrates how to implement the SubscriptionWidget component in a React application.

Note: The minimum width of the widget is 300px.

import { SubscriptionWidget } from "@0xernesto/web3-subscription-widget";

const YourAppComponent = () => {
	// Must have length >= 1
	const rpcUrlMap = {
		5: process.env.PRIVATE_GOERLI_RPC,
	};

	const theme = {
		primaryColor: "#cc0202",
		goodColor: "#47A66F",
		badColor: "#CC4545",
		primaryTextColor: "#000000",
		secondaryTextColor: "#4A4A4A",
		buttonTextColor: "#FFFFFF",
		containerBackgroundColor: "#FEF7EA",
		containerOutlineColor: "#DDF087",
		dropdownBackgroundColor: "#FEF7EA",
		dropdownOutlineColor: "#000000",
		optionActiveColor: "#C9C9C9",
		fontFamily: "sans-serif",
	};

	const lockConfig = {
		iconUrl:
			"https://images.ctfassets.net/y2ske730sjqp/4aEQ1zAUZF5pLSDtfviWjb/ba04f8d5bd01428f6e3803cc6effaf30/Netflix_N.png",
		lockAddress: "0x33201c65f9e7faa6d17d16c218dbc0ddf51c91b7",
		lockNetwork: 5,
		lockName: "Netflix 30 Day Subscription",
	};

	return (
		<div>
			<SubscriptionWidget
				rpcUrlMap={rpcUrlMap}
				lockConfig={lockConfig}
				maxWidth={600} // pixels
				theme={theme}
			/>
		</div>
	);
};

export default YourAppComponent;

Contributing

• On a new branch, open a PR for a particular set of changes.
• Name the PR according to Conventional Commits guidelines.
• All commits must be related to the PR name and commit messages must follow Conventional Commits guidelines.
• To make the enforcement of these guidelines easier, husky, commitlint, commitizen, and GitHub Actions have been configured for this project.
• All PRs must be squashed and merged to keep a clean history on the main branch.

When commiting to GitHub, instead of using git commit, run the folowing command and follow the instrucitons.

npm run commit

Publishing

This project is set up to publish the package via GitHub Actions after a push or merge to the main branch. The following is an example step-by-step process for publishing new releases.

NOTE: NPM_TOKEN must be obtained from your npm account and added to the repo's GitHub Actions secrets. WIDGETS_REPO_TOKEN needs to be generated in your GitHub settings and added to the repo's GitHub Actions secrets. GITHUB_TOKEN is a special secret that is automatically created for the repo, so there is no need to explicitely define it anywhere.

Ensure that only the following scopes are checked when creating WIDGETS_REPO_TOKEN:

• repo
  • repo:status
  • repo_deployment
  • public_repo
  • repo:invite
  • security_events
• workflow
• write:packages
  • read:packages

1. On your local machine, create a new local branch - for example, fix_for_the_bug.

git checkout -b fix_for_the_bug

2. Make code changes and commit as necessary.

git add -A

npm run commit

Follow the commitizen prompts, and the final commit message should be something like fix: "address part 1 of 5 of the bug"

3. Push the branch to the remote GitHub repo.

git push origin fix_for_the_bug

4. Create a new pull request from the fix_for_the_bug branch, review the code, and address any changes necessary. Make sure the pull request name follows Conventional Commits guidelines.

5. After the changes have been reviewed, the PR can be squashed and merged to the main branch. This will trigger the GitHub Action workflow that publishes the new release, based on the prefix used on the PR name.

The process above ensures that the code in the main branch always reflects that latest package version, and also keeps package versions consistent between npm and GitHub Packages.

Semantic Versioning

The default values for these prefixes are defined in the .releaserc.js file.

License

This project is released under the MIT License - see the LICENSE.md file for details.