{"id":20049033,"url":"https://github.com/unlock-protocol/scaffold-eth-unlock","last_synced_at":"2025-05-05T11:30:36.103Z","repository":{"id":49523237,"uuid":"516030411","full_name":"unlock-protocol/scaffold-eth-unlock","owner":"unlock-protocol","description":"Everything you need to get started building with Ethereum + Unlock Protocol","archived":false,"fork":false,"pushed_at":"2023-05-05T17:29:55.000Z","size":16245,"stargazers_count":6,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2023-08-19T20:51:02.960Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/unlock-protocol.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}},"created_at":"2022-07-20T15:11:49.000Z","updated_at":"2023-04-23T23:08:54.000Z","dependencies_parsed_at":"2023-02-06T10:17:53.863Z","dependency_job_id":null,"html_url":"https://github.com/unlock-protocol/scaffold-eth-unlock","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlock-protocol%2Fscaffold-eth-unlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlock-protocol%2Fscaffold-eth-unlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlock-protocol%2Fscaffold-eth-unlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlock-protocol%2Fscaffold-eth-unlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unlock-protocol","download_url":"https://codeload.github.com/unlock-protocol/scaffold-eth-unlock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224444089,"owners_count":17312126,"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-11-13T11:48:02.501Z","updated_at":"2024-11-13T11:48:03.376Z","avatar_url":"https://github.com/unlock-protocol.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scaffold-ETH + Unlock Protocol\n\nScaffold-ETH gives you everything you need to get started building on Ethereum and we've added some additional tools to help you get started in creating NFTs using Unlock Protocol.\n\n# 🏗 Scaffold-ETH\n\n\u003e everything you need to build on Ethereum! 🚀\n\n🧪 Quickly experiment with Solidity using a frontend that adapts to your smart contract:\n\n![image](https://user-images.githubusercontent.com/2653167/124158108-c14ca380-da56-11eb-967e-69cde37ca8eb.png)\n\n\n# 🏄‍♂️ Quick Start\n\nPrerequisites: [Node (v16 LTS)](https://nodejs.org/en/download/) plus [Yarn](https://classic.yarnpkg.com/en/docs/install/) and [Git](https://git-scm.com/downloads)\n\n\u003e clone/fork 🏗 scaffold-eth:\n\n```bash\ngit clone https://github.com/unlock-protocol/scaffold-eth-unlock.git\n```\n\n\u003e install and start your 👷‍ Hardhat chain:\n\n```bash\ncd scaffold-eth-unlock\nyarn install\nyarn chain\n```\n\n\u003e in a second terminal window, start your 📱 frontend:\n\n```bash\ncd scaffold-eth-unlock\nyarn start\n```\n\n\u003e in a third terminal window, 🛰 deploy your contract:\n\n```bash\ncd scaffold-eth-unlock\nyarn deploy\n```\n\n🔏 Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts`\n\n📝 Edit your frontend `App.jsx` in `packages/react-app/src`\n\n💼 Edit your deployment scripts in `packages/hardhat/deploy`\n\n📱 Open http://localhost:3000 to see the app\n\n# Unlock Settings\n\n⚙️ Configure Unlock-protocol variables on `settings` tab or `packages/react-app/src/components/UnlockVariables.jsx`\n\n🔧 Modify your Locked Navigation and Locked Content at `/src/components/LockedNav.jsx` and `/src/components/LockedContent.jsx`\n\n🚀 Deploy a new Lock with the Create Lock Component on `Dashboard` \n\n# 📚 Documentation\n\nDocumentation, tutorials, challenges, and many more resources, visit: [docs.scaffoldeth.io](https://docs.scaffoldeth.io)\n\n\n# 🍦 Other Flavors\n- [scaffold-eth-typescript](https://github.com/scaffold-eth/scaffold-eth-typescript)\n- [scaffold-eth-tailwind](https://github.com/stevenpslade/scaffold-eth-tailwind)\n- [scaffold-nextjs](https://github.com/scaffold-eth/scaffold-eth/tree/scaffold-nextjs)\n- [scaffold-chakra](https://github.com/scaffold-eth/scaffold-eth/tree/chakra-ui)\n- [eth-hooks](https://github.com/scaffold-eth/eth-hooks)\n- [eth-components](https://github.com/scaffold-eth/eth-components)\n- [scaffold-eth-expo](https://github.com/scaffold-eth/scaffold-eth-expo)\n- [scaffold-eth-truffle](https://github.com/trufflesuite/scaffold-eth)\n\n\n\n# 🔭 Learning Solidity\n\n📕 Read the docs: https://docs.soliditylang.org\n\n📚 Go through each topic from [solidity by example](https://solidity-by-example.org) editing `YourContract.sol` in **🏗 scaffold-eth**\n\n- [Primitive Data Types](https://solidity-by-example.org/primitives/)\n- [Mappings](https://solidity-by-example.org/mapping/)\n- [Structs](https://solidity-by-example.org/structs/)\n- [Modifiers](https://solidity-by-example.org/function-modifier/)\n- [Events](https://solidity-by-example.org/events/)\n- [Inheritance](https://solidity-by-example.org/inheritance/)\n- [Payable](https://solidity-by-example.org/payable/)\n- [Fallback](https://solidity-by-example.org/fallback/)\n\n📧 Learn the [Solidity globals and units](https://docs.soliditylang.org/en/latest/units-and-global-variables.html)\n\n# 🛠 Buidl\n\nCheck out all the [active branches](https://github.com/scaffold-eth/scaffold-eth/branches/active), [open issues](https://github.com/scaffold-eth/scaffold-eth/issues), and join/fund the 🏰 [BuidlGuidl](https://BuidlGuidl.com)!\n\n  \n - 🚤  [Follow the full Ethereum Speed Run](https://medium.com/@austin_48503/%EF%B8%8Fethereum-dev-speed-run-bd72bcba6a4c)\n\n\n - 🎟  [Create your first NFT](https://github.com/scaffold-eth/scaffold-eth/tree/simple-nft-example)\n - 🥩  [Build a staking smart contract](https://github.com/scaffold-eth/scaffold-eth/tree/challenge-1-decentralized-staking)\n - 🏵  [Deploy a token and vendor](https://github.com/scaffold-eth/scaffold-eth/tree/challenge-2-token-vendor)\n - 🎫  [Extend the NFT example to make a \"buyer mints\" marketplace](https://github.com/scaffold-eth/scaffold-eth/tree/buyer-mints-nft)\n - 🎲  [Learn about commit/reveal](https://github.com/scaffold-eth/scaffold-eth-examples/tree/commit-reveal-with-frontend)\n - ✍️  [Learn how ecrecover works](https://github.com/scaffold-eth/scaffold-eth-examples/tree/signature-recover)\n - 👩‍👩‍👧‍👧  [Build a multi-sig that uses off-chain signatures](https://github.com/scaffold-eth/scaffold-eth/tree/meta-multi-sig)\n - ⏳  [Extend the multi-sig to stream ETH](https://github.com/scaffold-eth/scaffold-eth/tree/streaming-meta-multi-sig)\n - ⚖️  [Learn how a simple DEX works](https://medium.com/@austin_48503/%EF%B8%8F-minimum-viable-exchange-d84f30bd0c90)\n - 🦍  [Ape into learning!](https://github.com/scaffold-eth/scaffold-eth/tree/aave-ape)\n\n# 💌 P.S.\n\n🌍 You need an RPC key for testnets and production deployments, create an [Alchemy](https://www.alchemy.com/) account and replace the value of `ALCHEMY_KEY = xxx` in `packages/react-app/src/constants.js` with your new key.\n\n📣 Make sure you update the `InfuraID` before you go to production. Huge thanks to [Infura](https://infura.io/) for our special account that fields 7m req/day!\n\n# 🏃💨 Speedrun Ethereum\nRegister as a builder [here](https://speedrunethereum.com) and start on some of the challenges and build a portfolio.\n\n# 💬 Support Chat\n\nJoin the telegram [support chat 💬](https://t.me/joinchat/KByvmRe5wkR-8F_zz6AjpA) to ask questions and find others building with 🏗 scaffold-eth!\n\n---\n\n🙏 Please check out our [Gitcoin grant](https://gitcoin.co/grants/2851/scaffold-eth) too!\n\n### Automated with Gitpod\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#github.com/scaffold-eth/scaffold-eth)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funlock-protocol%2Fscaffold-eth-unlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funlock-protocol%2Fscaffold-eth-unlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funlock-protocol%2Fscaffold-eth-unlock/lists"}