🏗 Scaffold-NFT

Documentation

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

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

Requirements

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

• Node (>= v18.17)
• Yarn (v1 or v2+)
• Git

Quickstart

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

1. Install dependencies if it was skipped in CLI:

cd my-dapp-example
yarn install

2. Run a local network in the first terminal:

yarn chain

This command starts a local Ethereum network using Foundry. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in packages/foundry/foundry.toml.

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

yarn deploy

This command deploys a test smart contract to the local network. The contract is located in packages/foundry/contracts and can be modified to suit your needs. The yarn deploy command uses the deploy script located in packages/foundry/script to deploy the contract to the network. You can also customize the deploy script.

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 the Debug Contracts page. You can tweak the app config in packages/nextjs/scaffold.config.ts.

Run smart contract test with yarn foundry:test

• Edit your smart contract YourContract.sol in packages/foundry/contracts
• Edit your frontend homepage at packages/nextjs/app/page.tsx. For guidance on routing and configuring pages/layouts checkout the Next.js documentation.
• Edit your deployment scripts in packages/foundry/script

Documentation

Visit our docs to learn how to start building with Scaffold-ETH 2.

Contributing to Scaffold-NFT

We welcome contributions to Scaffold-NFT!

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