nftfy-aggregator's Introduction

Nftfy Aggregator

A Toolkit for NFT Collections

Prerequisites

Install Node.js and NPM
Install Yarn
Request free Reservoir API key

Installation

$ yarn install

Configuration

To preview your configuration locally you can copy the values you want to use from env.development or env.production into a new file called .env.local.

Note: Environment variables can also be added during deployment via deployment platforms like vercel.

Required Environment Variables

Environment Variable	Required	Description	Example
NEXT_PUBLIC_RESERVOIR_API_BASE	`true`	The Reservoir API base URL. Available on Mainnet, Rinkeby, Goerli, and Optimism.	https://api-rinkeby.reservoir.tools/ https://api.reservoir.tools/
NEXT_PUBLIC_CHAIN_ID	`true`	The Ethereum network to be used. 1 for Etherem Mainnet and 4 for Rinkeby Testnet, etc.	1 4
NEXT_PUBLIC_PROXY_API_BASE	`true`	The proxy API used to pass the Reservoir API key without exposing it to the client.	/api/reservoir
NEXT_PUBLIC_RESERVOIR_API_KEY	`true`	Reservoir API key provided by the Reservoir Protocol. Get your own API key.	123e4567-e89b-12d3-a456-426614174000
NEXT_PUBLIC_ALCHEMY_ID	`true`	Alchemy API key required for buying items on mobile. Get your own API key here.	123e4567-e89b-12d3-a456-426614174000