Overview
The Rarity Score Template is a tool that allows users to implement their own rarity tools for NFT collections. It provides features for creators, buyers, and developers to meet their specific needs. Deploying the template with Vercel ensures automatic deployment of changes. The template is responsive and can be used locally or on a server.
Features
- List NFTs from JSON: The template allows users to list their NFTs from a JSON file, making it easy to manage and display their collection.
- Filter NFTs based on traits: Users can filter their NFTs based on specific traits or attributes, helping them organize and categorize their collection.
- Share NFT for token_id: This feature allows users to easily share specific NFTs by displaying the rarity score, rarity rank, and price, providing useful information for potential buyers.
- Automatic deployment with Vercel: Users can deploy the template with Vercel, ensuring any changes made are automatically deployed.
- Responsive webpages: All webpages generated by the template are responsive, ensuring a seamless experience across different devices.
Installation
To use the Rarity Score Template locally, follow these steps:
- Install the required packages.
- Change the JSON file in
data/collection.jsonto your own collection’s JSON file. If you encounter any errors, report them as issues. The JSON file should follow Opensea standards. - Modify the
config/index.jsfile:- Set the
envvariable to “local” if you are using the template locally, or “prod” if deploying. - Set the
LOCAL_API_URLto the port at which the app is running locally. The default value ishttp://localhost:3000. - Set the
API_URLto your Vercel URL when deploying. - Set the
COLLECTION_NAMEto your Opensea collection name. - Set the
COLLECTION_TITLEto the desired website title for SEO. - Set the
COLLECTION_DESCRIPTIONto the desired og:description for SEO. - Set the
COLLECTION_IMG_LINKto the desired og:image URL for the website’s SEO.
- Set the
To fetch updates from the repository, run git pull origin main.
Summary
The Rarity Score Template is a versatile tool that caters to the needs of NFT creators, buyers, and developers. It allows creators to easily manage and display their NFT collections, while providing buyers with valuable information about the rarity score, rank, and price of individual NFTs. Developers benefit from clear documentation and the ability to iterate on the project. The template can be used locally or deployed with Vercel for automatic deployment. Overall, the Rarity Score Template is a comprehensive solution for anyone involved in the NFT ecosystem.