๐งช Special thanks for the tempalte to Scaffold-ETH 2 (Documentation)
โ๏ธ Built using NextJS, RainbowKit, 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 around wagmi 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 (>= v18.17)
- Yarn (v1 or v2+)
- Git
To get started with Scaffold-ETH 2, follow the steps below:
- Clone this repo & install dependencies
git clone https://github.com/scaffold-eth/scaffold-eth-2.git
cd scaffold-eth-2
yarn install
- Run a local network in the first terminal:
yarn chain
This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in hardhat.config.ts
.
- Create a file .env in hardhat containing
- ETHERSCAN_API_KEY
- ALCHEMY_API_KEY
- DEPLOYER_PRIVATE_KEY (only needed when deploying outside local network)
- Create a file .env.local in nextjs containing
- PINATA_JWT
- NEXT_PUBLIC_CONTRACT_ADDRESS (from the deploy command)
- NEXT_PUBLIC_DEPLOYER_PRIVATE_KEY (which can be found in hardhat.config.ts for local network)
- NEXT_PUBLIC_ALCHEMY_API_KEY (only needed when deploying outside local network)
- On a second terminal, deploy the test contract:
yarn deploy
This is where you will get the contract address to be placed in .env.local.
This command deploys a test smart contract to the local network. The contract is located in packages/hardhat/contracts
and can be modified to suit your needs. The yarn deploy
command uses the deploy script located in packages/hardhat/deploy
to deploy the contract to the network. You can also customize the deploy script.
- 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 the Debug Contracts
page. You can tweak the app config in packages/nextjs/scaffold.config.ts
.
Run smart contract test with yarn hardhat:test
- Edit your smart contract
BubbleBreakerBadge.sol
inpackages/hardhat/contracts
- Edit your frontend in
packages/nextjs/pages
- Edit your deployment scripts in
packages/hardhat/deploy
Visit our docs to learn how to start building with Scaffold-ETH 2.
To know more about its features, check out our website.
We welcome contributions to Scaffold-ETH 2!
Please see CONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.