{"id":13715047,"url":"https://github.com/kristianfreeman/openmonetizationwallet","last_synced_at":"2025-04-25T00:32:06.734Z","repository":{"id":145398617,"uuid":"264293475","full_name":"kristianfreeman/openmonetizationwallet","owner":"kristianfreeman","description":"👛 Tools for managing a vanity Web Monetization wallet","archived":false,"fork":false,"pushed_at":"2023-06-10T00:44:14.000Z","size":1112,"stargazers_count":11,"open_issues_count":13,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-04T00:10:35.147Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://omw-demo.signalnerve.workers.dev/admin/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kristianfreeman.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,"governance":null}},"created_at":"2020-05-15T20:36:12.000Z","updated_at":"2024-07-25T17:06:26.000Z","dependencies_parsed_at":"2023-08-25T00:51:17.939Z","dependency_job_id":null,"html_url":"https://github.com/kristianfreeman/openmonetizationwallet","commit_stats":null,"previous_names":["kristianfreeman/openmonetizationwallet"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristianfreeman%2Fopenmonetizationwallet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristianfreeman%2Fopenmonetizationwallet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristianfreeman%2Fopenmonetizationwallet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristianfreeman%2Fopenmonetizationwallet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kristianfreeman","download_url":"https://codeload.github.com/kristianfreeman/openmonetizationwallet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223975092,"owners_count":17234736,"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-08-03T00:00:53.348Z","updated_at":"2024-11-10T15:40:42.243Z","avatar_url":"https://github.com/kristianfreeman.png","language":"JavaScript","funding_links":[],"categories":["Resources"],"sub_categories":["Tools"],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003eOpen Monetization Wallet\u003c/h1\u003e\n  \u003cp\u003eTools for managing your vanity Web Monetization wallet\u003c/p\u003e\n\u003c/div\u003e\n\n## Summary\n\nOpen Monetization Wallet (OMW) makes it easier to accept payments with the Web Monetization API at scale. Some features:\n\n- Custom wallet URLs: own your own \"Payment Pointer\", e.g. $wallet.signalnerve.com, instead of $pay.stronghold.co/abcdef123\n- Change between wallets/providers with no downtime\n- Logs of incoming payment requests\n- Revenue sharing between multiple wallets, e.g. for multiple team members\n- Infinitely scalable with serverless technology\n- Free and open-source\n\n![Example](./.github/example.png)\n\n## Prerequisites\n\n- A [Cloudflare Workers](https://workers.dev) unlimited plan to deploy your OMW instance\n- If deploying in front of a domain, a configured Cloudflare zone (see the \"Origin\" section of \"Configuration\" below)\n- [`wrangler`][wrangler] cli tool installed and configured (see the [Quick Start][quick start] in the docs)\n- A configured Web Monetization wallet + payment pointer for use in your account, e.g. from [Stronghold](https://stronghold.co/)\n\n## Configuration\n\n### `wrangler.toml`\n\nCopy `wrangler.toml.example` to `wrangler.toml` and begin filling out the file to prepare your OMW instance for deployment.\n\n### KV Namespace\n\nOMW assumes the existence of `DB`, a KV namespace that is used for writing wallet and log information from your application. To create this namespace, use `wrangler`:\n\n``` sh\n$ wrangler kv:namespace create DB\n```\n\nThis will create a KV namespace for your project and give you the appropriate code to copy into `wrangler.toml`. Note that the example `wrangler.toml` includes most of this definition already, so you can simply replace the `$BINDING_ID` value with your unique binding ID to configure the namespace.\n\n### Instance Password\n\nOMW instances are password-protected by default to prevent unauthorized access to your admin panel. To set a randomly generated password, run the included `bin/generate_secret` command. This password will only be shown once, so make sure you write it down somewhere!\n\n```sh\n$ bin/generate_secret\n# If deploying multiple environments, pass the environment name\n# as an argument to generate a new secret for that env\n# $ bin/generate_secret [optional_environment]\n```\n\nGenerally, it's recommended that you _fork_ OMW for your own instance, which will allow you to opt into the automatic GitHub Actions deployment (see \"Deploying\") and not need to manage your own instance locally. [Better instructions here are in the works!](https://github.com/signalnerve/openmonetizationwallet/issues/6)\n\nTo prepare your OMW instance for deployment with GitHub Actions, you should generate two [GitHub secrets][secrets] in your repository's Settings section: `CF_ACCOUNT_ID`, which represents your Cloudflare account ID, and `CF_API_TOKEN`, a unique API token created for deploying Cloudflare Workers projects. For more help finding these values, check out the [Workers Quick Start][quick start].\n\n### Custom domains\n\nIf you'd like to deploy your OMW instance to a custom domain, you'll need to configure it inside of the Cloudflare dashboard. For more information on this, see the Workers Quick Start section [\"Publish to your Domain\"][domain]. Your `wrangler.toml` should include a `zone_id` and `route`, for instance:\n\n```toml\nzone_id = \"abcdef123\"\nroute = \"mycustomwalletdomain.com/*\"\n```\n\n## Deploying\n\nOMW is set up to allow automatic deployments using [GitHub Actions][gha]. This means that whenever a new Git commit is pushed onto the `master` branch, GitHub Actions will automatically build the project and deploy it. \n\nYou can also deploy manually from your local machine:\n\n``` sh\nyarn run gatsby:build\nwrangler publish\n```\n\n## Development\n\nOMW uses Gatsby and Wrangler for local development. You can begin developing or exploring the application locally by running the following commands:\n\n``` sh\nyarn\ngatsby develop # Local UI development\nwrangler dev   # Test serverless/edge functionality\n```\n\nNote that many of the edge/serverless operations, such as loading KV data locally, aren't supported inside of the `gatsby develop` workflow. This is something I'd like to fix in the future, and I've opened a ticket for tracking it: https://github.com/signalnerve/openmonetizationwallet/issues/7\n\n## License\n\nOMW is licensed under the [MIT license](https://github.com/signalnerve/openmonetizationwallet/blob/master/LICENSE).\n\n[quick start]: https://developers.cloudflare.com/workers/quickstart#configure\n[wrangler]: https://github.com/cloudflare/wrangler\n[gha]: https://github.com/features/actions\n[secrets]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets\n[domain]: https://developers.cloudflare.com/workers/quickstart#publish-to-your-domain\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkristianfreeman%2Fopenmonetizationwallet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkristianfreeman%2Fopenmonetizationwallet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkristianfreeman%2Fopenmonetizationwallet/lists"}