glestudios / rarity-analyzer Goto Github PK

An open source rarity discord bot and site for everyone.

• Overview
• How do I generate for my collection?
• Setup the discord bot
• Developing
• Built with
• Contributing

Rarity Analyzer from the PunkScapes community is an open source solution for generating the rarity site and a discord bot of your collections on ERC-721 standard.

• OneDayPunks Collection Rarity
• The Seven Collection Rarity

Before you generate your rarity site, Ready your collections data (ERC-721 format) and then few configuration values Sample ENV.

1. Fork this project (make it private if using bots)
2. Clone it locally or start editing online in github (Press dot / change url from github.com to github.dev) without leaving your browser.
3. Update collection data replace the sample file located at data/collection.json
4. Update collection configuration, Create .env.production refer/copy keys from .env.sample
5. Press Deploy below and select the repo or if local run npx vercel --prod.

NOTE: A comprehensive guide about will be added soon.

• Deploy your rarity site and add the bots config in the .env.production file.
• Create a discord application
• Add your INTERACTIONS ENDPOINT URL <your-rarity-site>/api/rarity
• Authorize your discord server with bot and application.commands bot permission
• Start interacting with your rarity bot.

The bot interaction api is at ``

• WIP

Note: Make sure you have the latest version of node installed ^14.16.

cd rarity-analyzer;
nvm install; # to install the version in .nvmrc

1. Clone this repo with git
2. Install dependencies by running yarn
3. Start the development server with yarn dev
4. Open development site by going to https://localhost:3000

• React.js
• Next.js
• Typescript
• TailwindCSS
• Yarn
• Prettier

Please feel free to open an issue for any suggestions you might have for this project.

Thanks for showing interest in contributing to Rarity analyzer.

CONTRIBUTING.md - WIP