Repository files navigation

🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.

⚙️ Built using NextJS, RainbowKit, Foundry/Hardhat, Wagmi, Viem, and Typescript.

• ✅Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
• 🪝Custom hooks: Collection of React hooks wrapper aroundwagmi to simplify interactions with smart contracts with typescript autocompletion.
• 🧱Components: Collection of common web3 components to quickly build your frontend.
• 🔥Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
• 🔐Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum network.

Before you begin, you need to install the following tools:

• Node (>= v20.18.3)
• Yarn (v1 orv2+)
• Git

To get started with Scaffold-ETH 2, follow the steps below:

1. Install the latest version of Scaffold-ETH 2

npx create-eth@latest

This command will install all the necessary packages and dependencies, so it might take a while.

2. Run a local network in the first terminal:

yarn chain

This command starts a local Ethereum network that runs on your local machine and can be used for testing and development. Learn how tocustomize your network configuration.

3. On a second terminal, deploy the test contract:

yarn deploy

This command deploys a test smart contract to the local network. You can find more information about how to customize your contract and deployment script in ourdocumentation.

4. On a third terminal, start your NextJS app:

yarn start

Visit your app on:http://localhost:3000. You can interact with your smart contract using theDebug Contracts page. You can tweak the app config inpackages/nextjs/scaffold.config.ts.

What's next:

Visit theWhat's next section of our docs to learn how to:

• Edit your smart contracts
• Edit your deployment scripts
• Customize your frontend
• Edit the app config
• Writing and running tests
• Setting up external services and API keys

Visit ourdocs to learn all the technical details and guides of Scaffold-ETH 2.

To know more about its features, check out ourwebsite.

We welcome contributions to Scaffold-ETH 2!

Please seeCONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.