GitHub

scaffold-eth /scaffold-eth

๐Ÿ— forkable Ethereum dev stack focused on fast product iterations

โ˜… 9,037โ‘‚ 3,368๐Ÿ‘ 4โ‘ƒ 724โ— 0โ–ค 0
CSSMITCreated 2020-04-27scaffoldeth.io
+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

Snapshot: 2026-11-16T09:23:14Z ยท Data license Apache-2.0 ยท JSON