README.md

Cyfrin .env Pledge NFT

A soulbound NFT representing a developer's commitment to the Cyfrin Updraft .env Pledge.

• Cyfrin .env Pledge NFT
• Getting Started
  • Requirements
  • Quickstart
• Usage
  • Deploy to Anvil
  • Mint
  • View Token URI
  • Testing

Getting Started

Requirements

• git
  • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
• foundry
  • You'll know you did it right if you can run forge --version and you see a response like forge x.x.x

Quickstart

git clone https://github.com/Cyfrin/env-pledge-project
cd env-pledge-project/contracts
make install
make build

Usage

Note: The following commands are for local development with Anvil. Testnet/mainnet deployment instructions will be added after review.

Deploy to Anvil

# Terminal 1 - Start local Anvil node
make anvil

# Terminal 2 - Deploy (requires .env with PRIVATE_KEY)
cp .env.example .env
make deploy-anvil

Mint

# Set CONTRACT_ADDRESS and USERNAME in .env, then:
make mint

View Token URI

# Set CONTRACT_ADDRESS and TOKEN_ID in .env, then:
make token-uri

Testing

make test      # Run tests
make test-v    # Run tests with verbosity (-vvv)