Skip to content

Latest commit

 

History

History
136 lines (70 loc) · 3.96 KB

README.md

File metadata and controls

136 lines (70 loc) · 3.96 KB
Raw

GitHub license

GitHub issues

GitHub pull requests

NFT Rarity Generator

An NFT rarity generator compatible with multiple chains

Contents
  1. Prerequisite
  2. Installation
  3. Usage
  4. Roadmap
  5. License
  6. Contributing
  7. Contact

Installation

If you are cloning the project then run this first, otherwise you can download the source code on the release page and skip this step.

git clone https://github.com/0xSooki/nft-rarity-generator.git

Go to the root of your folder and run this command

npm install

Alternatively you can run this command if you have yarn installed.

yarn install

(back to top)

Prerequisite

  1. Node version: >= 16.16.0
  2. Alchemy profile: Alchemy API key is required
  3. MongoDB: local or cluster link
  4. You must have your .env file setup correctly. Copy the .env.example and remove the .example part and provide the following fields: ALCHEMY_API_KEY, MONGO_DB_URL, CONTRACT_ADDRESS and FILE_NAME (the latter is optional)

(back to top)

Usage

In the config.js you can set the contractAddress, fileName, logPages features.

Set the contractAddress to the collection address you would like to generate the data for.

const contractAddress = "0x8a90cab2b38dba80c64b7734e58ee1db38b8992e"

Set the fileName to the name you would like to name the output file

const fileName = "Doodles"

logPages to true if you would like to see the process of the data generation. (set to true by default)

const logPages = true

If you're done setting everything up, you can start the code and wait for the data to be generated.

npm run build

After finished running the data will be saved in the build folder in the root directory

(back to top)

Roadmap

  • Base rarity generator

  • Add support for multiple rarity generation methods

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

  1. Fork the Project

  2. Create your Feature Branch (git checkout -b feature-name develop)

  3. Commit your Changes (git commit -m 'Add some AmazingFeature')

  4. Push to the Branch (git push origin feature-name)

  5. Open a Pull Request to merge your branch into develop

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

sooki.eth - @sooki - [email protected]

Project Link: https://https://github.com/0xSooki/nft-rarity-generator

(back to top)