{"id":14990342,"url":"https://github.com/digitaldonkey/web3ready","last_synced_at":"2025-06-29T03:41:57.288Z","repository":{"id":138705153,"uuid":"152126738","full_name":"digitaldonkey/web3ready","owner":"digitaldonkey","description":"Create Dapp's without implementing any web3 provider yourself","archived":false,"fork":false,"pushed_at":"2020-05-31T01:18:37.000Z","size":16348,"stargazers_count":26,"open_issues_count":19,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-27T22:40:29.170Z","etag":null,"topics":["web-component","web3","web3-dapp","web3-javascript","web3js"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/digitaldonkey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-08T18:25:33.000Z","updated_at":"2023-02-20T02:19:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"40224824-de83-4236-8423-e4bbfc5da701","html_url":"https://github.com/digitaldonkey/web3ready","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitaldonkey%2Fweb3ready","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitaldonkey%2Fweb3ready/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitaldonkey%2Fweb3ready/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digitaldonkey%2Fweb3ready/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/digitaldonkey","download_url":"https://codeload.github.com/digitaldonkey/web3ready/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505928,"owners_count":21115354,"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":["web-component","web3","web3-dapp","web3-javascript","web3js"],"created_at":"2024-09-24T14:19:55.268Z","updated_at":"2025-04-12T02:11:24.128Z","avatar_url":"https://github.com/digitaldonkey.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# web3-ready\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/digitaldonkey/web3ready.svg)](https://greenkeeper.io/)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\nWeb3-ready takes away the burden of implementing different providers while developing a web3 application. \n\n**Demo**\n\n[https://web3ready.github.io/latest](https://web3ready.github.io/latest)\n\n**Development goals**\n\n* **Minimal footprint**: Try to only load the bare minimum of code initially. Lazy load more if required\n* **Don't store any user data**. We only persist the last selected web3 provider. In case this provider supports auto-reconnect we can initialize on page load. \n* **Simplistic UX**: Don't bother the user with anything that can be solved behind his back. \n* **Developer friendly**: A web3 developer includes the web3-ready web-component and implements a window.web3Ready(web3, account) function to start his Dapp after the user connected. \n* Common UI for multiple Dapps. The idea is simplify web3 interaction by providing the **same interaction pattern to connect to any web3 Dapp**. \n* Multilingual (but not yet translated. See src/translations)\n\n## Sneak preview\n\nSome of the current screens. \n\n![Select provider](https://github.com/digitaldonkey/web3ready/blob/master/docs/selectProvider.png?raw=true)\n![Metamask if unlocked](https://github.com/digitaldonkey/web3ready/blob/master/docs/Metamask.png?raw=true)\n![Connect with WalletConnect](https://github.com/digitaldonkey/web3ready/blob/master/docs/walletConnect.png?raw=true)\n![Connect with Ledger](https://github.com/digitaldonkey/web3ready/blob/master/docs/ledger.png?raw=true)\n\nDesign credits go to [Balance Manager](https://manager.balance.io/).\n\n## Usage\n\n```\n\u003cscript src=\"https://unpkg.com/vue\"\u003e\u003c/script\u003e\n\u003cscript src=\"https://dist/web3-ready.min.js\"\u003e\u003c/script\u003e\n...\n\u003cweb3-ready\n    dapp-name=\"My new Dapp\"\n    required-network=\"42\"\n    rpc-url=\"https://mainnet.infura.io/drupal\"\n    enable-providers=\"metamask,walletConnect,ledger\"\n\u003e\u003c/web3-ready\u003e\n\n\u003cscript\u003e\nwindow.addEventListener(\"web3Ready\", function(web3, account){ \n\t// Do something with a initialized web3\n\t// And the user's chosen account address\n});\n\u003c/script\u003e\n```\n### Properties \n\u003cul\u003e\n  \u003cli\u003e\u003cstrong\u003edapp-name\u003c/strong\u003e\n    \u003cbr\u003eUnique name for your dapp\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003erequired-network\u003c/strong\u003e\n    \u003cbr\u003eRequired network Id.\n    \u003cbr\u003ePlease refer to \u003ccode\u003esrc/translations.default.js:globals.networks\u003c/code\u003e to see valid options.\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003erpc-url\u003c/strong\u003e\n    \u003cbr\u003eRPC to connect to Ethereum\n    \u003cul\u003e\n      \u003cli\u003eMust match required-network\u003c/li\u003e\n      \u003cli\u003eSet up your own Ethereum node or use a service like \u003ca href=\"https://infura.io\"\u003einfura.io\u003c/a\u003e\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003eenable-providers\u003c/strong\u003e\n    \u003cbr\u003eList of provider is's separated by comma.\u003cbr\u003ePlease refer to \u003ccode\u003esrc/translations.default.js:globals.signers\u003c/code\u003e to see valid options\n  \u003c/li\u003e\n\u003c/ul\u003e\n\nTo integrate in your website make sure the site is served via **https**. This is partly **required** (at least for Ledger).\n\n## Todo's\n\n* Add Tresor provider\n* Lazy load Provider dialogues\n* provide CDN based and non-CDN version\n\n\n## Project setup\n```\nnpm install\n```\n\n### Compiles and hot-reloads for development\n\n```\nnpm run serve\n```\n\n### Compiles and minifies for production\n```\nnpm run build\n```\n\n### Git\nCommit with a **semantic-release** friendly commit message\n\n```\nnpm run commit\n```\n\n\n### Testing this build\n\n```\nnpm run build\n```\nTest the web-comüonent with dist/index.html\n\n### Lints and fixes files\n```\nnpm run lint\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigitaldonkey%2Fweb3ready","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigitaldonkey%2Fweb3ready","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigitaldonkey%2Fweb3ready/lists"}