First, initialize the repo:

npm install

Then, You will need to create an API key to connect to your pinata.cloud storage. Follow this link for more information, create a new key here, then add the following .env file to the root of this project:

PINATA_JWT=<your JWT>
PINATA_API_KEY=<Your API Key>
PINATA_API_SECRET=<Your API Secret>

Furthermore, You will need to add to your .env file a mnemonic to be able to deploy to Polygon (visit this website to generate a mnemonic).

POLYGON_MNEMONIC=<your mnemonic>

# Run a local blockchain fork
npx hardhat node [--fork <JSON-RPC server url>]

# Run a local ipfs node
export IPFS_PATH=`pwd`/ipfs/.go-ipfs
cd ipfs/
npx go-ipfs init#if not already done
npx go-ipfs daemon

npx hardhat run scripts/full_process.ts [--network <network name>]

# you can also test your contract using the same network
npx hardhat test --network <network name>

This folder contains all the contracts and solidity libraries. You can interact with them using hardhat:

# Compile contracts
npx hardat compile

# Deploy contracts (see hardhat.config.ts)
npx hardhat deploy --network <network name>

this folder contains all the data that will be deployed on IPFS.

This folder contains scripts and explanations for the NFT's metadatas. See the following readme for more details.

This folder contains various programs to ease the process of deployment.

# Run a script (check the related file to use the right command)
node <file.mjs path> [optional arguments]
#OR
npx ts-node <file.ts path> [optional arguments]
#OR
npx hardhat run [--network <network name>] <file path> [optional arguments]

This folder contains unit tests for the contracts.

npx hardhat test [<files name>]

This file is the entry point for all hardhat-related commands. There should be nothing to add here, unless you want a new network for your test or deployment. here is the structure:

interface HttpNetworkUserConfig {
  chainId?: number;
  from?: string;
  gas?: "auto" | number;
  gasPrice?: "auto" | number;
  gasMultiplier?: number;
  url?: string;
  timeout?: number;
  httpHeaders?: { [name: string]: string };
  accounts?: HttpNetworkAccountsUserConfig;
}