scaffold-eth /scaffold-eth
๐ forkable Ethereum dev stack focused on fast product iterations
โ
9,037โ 3,368๐ 4โ 724โ 0โค 0
+1
Daily
9,037
stars
3,368
forks
4
watchers
724
prs
0
issues
0
releases
README
๐ Scaffold-ETH ๐จ๐จ This repository has been archived and is now read-only ๐จ๐จ You are still welcome to fork and use as a template but no more changes will be made to this repository. ๐ Scaffold-ETH 2 is the latest version, we recommend you fork: https://github.com/scaffold-eth/scaffold-eth-2 --- everything you need to build on Ethereum! ๐ ๐งช Quickly experiment with Solidity using a frontend that adapts to your smart contract: !image ๐โโ๏ธ Quick Start Prerequisites: Node (v18 LTS) plus Yarn (v1.x) and Git ๐จ If you are using a version 1๏ธโฃ clone/fork ๐ scaffold-eth: bash git clone https://github.com/scaffold-eth/scaffold-eth.git 2๏ธโฃ install and start your ๐ทโ Hardhat chain: bash cd scaffold-eth yarn install yarn chain 3๏ธโฃ in a second terminal window, start your ๐ฑ frontend: ๐จ if your contracts are not deployed to localhost, you will need to update the default network in App.jsx to match your default network in hardhat-config.js. bash cd scaffold-eth yarn start 4๏ธโฃ in a third terminal window, ๐ฐ deploy your contract: ๐จ if you are not deploying to localhost, you will need to run yarn generate first and then fund the deployer account. To view account balances, run yarn account. You will also need to update hardhat-config.js with the correct default network. bash cd scaffold-eth yarn deploy ๐ Edit your smart contract YourContract.sol in packages/hardhat/contracts ๐ Edit your frontend App.jsx in packages/react-app/src ๐ผ Edit your deployment scripts in packages/hardhat/deploy ๐ฑ Open http://localhost:3000 to see the app ๐จ๐ก To deploy to a public domain, use yarn surge. You will need to have a surge account and have the surge CLI installed. There is also the option to deploy to IPFS using yarn ipfs and yarn s3 to deploy to an AWS bucket ๐ชฃ There are scripts in the packages/react-app/src/scripts folder to help with this. ๐ Documentation Documentation, tutorials, challenges, and many more resources, visit: docs.scaffoldeth.io ๐ฆ Other Flavors - scaffold-eth-typescript - scaffold-eth-tailwind - scaffold-nextjs - scaffold-chakra - Scaffold-ETH x Buildbear - eth-hooks - eth-components - scaffold-eth-expo - scaffold-eth-truffle ๐ญ Learning Solidity ๐ Read the docs: https://docs.soliditylang.org ๐ Go through each topic from solidity by example editing YourContract.sol in ๐ scaffold-eth - Primitive Data Types - Mappings - Structs - Modifiers - Events - Inheritance - Payable - Fallback ๐ง Learn the Solidity globals and units ๐ Buidl Check out all the active branches, open issues, and join/fund the ๐ฐ BuidlGuidl! - ๐ค Follow the full Ethereum Speed Run - ๐ Create your first NFT - ๐ฅฉ Build a staking smart contract - ๐ต Deploy a token and vendor - ๐ซ Extend the NFT example to make a "buyer mints" marketplace - ๐ฒ Learn about commit/reveal - โ๏ธ Learn how ecrecover works - ๐ฉโ๐ฉโ๐งโ๐ง Build a multi-sig that uses off-chain signatures - โณ Extend the multi-sig to stream ETH - โ๏ธ Learn how a simple DEX works - ๐ฆ Ap