Skip to content

Latest commit

 

History

History
266 lines (171 loc) · 4.73 KB

README.md

File metadata and controls

266 lines (171 loc) · 4.73 KB
Raw

Vite-react-ts-hardhat-web3-NFT tutorial

building a Web3 NFT Minting Dapp with React, TS, Vite, Vitest, Hardhat

Requirements

  • git

    • if you've installed correct git you can run git --version and you see a response like git version x.x.x

  • Nodejs

    • if you`ve installed nodejs correct you can run:

      • node --versionand get an ouput like: vx.x.x

  • Yarn instead of npm

    • if you`ve installed yarn correct if you can run:

      • yarn --version And get an output like: x.x.x

      • You might need to install it with npm

If you like this approach npx and npm instead of yarn, you can use npx for execution and npm for installing dependencies.

Quickstart

  1. Clone and install dependencies

having all the requirements, run the following code:

git clone https://github.com/crisanlucid/vite-react-ts-hardhat-web3-NFT-tutorial/

cd vite-react-ts-hardhat-web3-NFT-tutorial

Next:


yarn install

or


npm i
  1. You can now test the contracts!

yarn hardhat test

or


yarn hardhat test

Usage

If you run yarn hardhat --help you'll get an output of all the tasks you can run.

Deploying Contracts


yarn hardhat deploy

This will deploy your contracts to a local network. Additionally, if on a local network, it will deploy mock Chainlink contracts for you to interact with. If you'd like to interact with your deployed contracts, skip down to Interacting with Deployed Contracts.

Run a Local Network

One of the best ways to test and interact with smart contracts is with a local network. To run a local network with all your contracts in it, run the following:


yarn hardhat node

You'll get a local blockchain, private keys, contracts deployed (from the deploy folder scripts), and an endpoint to potentially add to an EVM wallet.

Frontend

cd dApp_NFT

and

yarn && yarn dev

or

npm install && npm dev

  1. Navigate and click NFT link

  2. Login with Metamask

    • install Metamask
    • log in
    • change Network: Rinkeby
    • add some fake Eth

  3. Click mint button and appove from Metamask

Other stuff

check tests

yarn test

or

npm test

BONUS:

HOW TO Install Tailwind)

cd dApp_NFT
  1. Setup Dependecies
yarn add -D tailwindcss postcss autoprefixer @tailwindcss/forms
npx tailwindcss init

or

npm install -D tailwindcss postcss autoprefixer
  1. Create file tailwind.config.cjs ; cjs - common js file
module.exports = {
  purge: ['./src/**/*.{js,jsx,ts,tsx}', './public/index.html'],
  mode: 'jit',
  darkMode: false, // or 'media' or 'class'
  theme: {
    fontFamily: {
      display: ['Open Sans', 'sans-serif'],
      body: ['Open Sans', 'sans-serif']
    },
    extend: {
      screens: {
        mf: '990px'
      },
      keyframes: {
        'slide-in': {
          '0%': {
            '-webkit-transform': 'translateX(120%)',
            transform: 'translateX(120%)'
          },
          '100%': {
            '-webkit-transform': 'translateX(0%)',
            transform: 'translateX(0%)'
          }
        }
      },
      animation: {
        'slide-in': 'slide-in 0.5s ease-out'
      }
    }
  },
  variants: {
    extend: {}
  },
  plugins: [require('@tailwindcss/forms')]
};
  1. Create a file postcss.config.cjs

with the config:

module.exports = {
  plugins: {
    tailwindcss: {},
    autoprefixer: {},
  },
}
  1. Update dApp_NFT\src\index.css
@tailwind base;
@tailwind components;
@tailwind utilities;

HOw TO put API into Frontend App

  1. compile the contracts from root (outside of dAppp_NFT)
yarn compile

or

npm compile
  1. Copy JSON file from artifacts/contracts/NFT.sol/NFT.json
cp artifacts/contracts/NFT.sol/NFT.json dApp_NFT/src/utils/NFT.contract.json
  1. create a file constants.ts in ./dApp_NFT/src/utils
import nft from './NFT.contract.json';

// NFT contract goes here
export const contractNFTAddress = '';//copy the contract address when you deploy Smart Contract
export const contract_NFT_ABI = nft.abi;

Performance optimizations

For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable TS_NODE_TRANSPILE_ONLY to 1 in hardhat's environment. For more details see the documentation.

Resources:

https://rahulsethuram.medium.com/the-new-solidity-dev-stack-buidler-ethers-waffle-typescript-tutorial-f07917de48ae