piersy/celo-nft-minter

GEO Collection

An awesome NFT minter built on the Celo blockchain

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Smart Contract Deployment
3. Contributing
4. License
5. Contact

About The Project

NFT minter is a decentralized application that enables users view and mint NFTs to an address. These NFTs are minted on the Celo blockchain and its metadata are saved on IPFS(InterPlanetary File System)

(back to top)

👨‍💻 Technologies

Frameworks and libraries used in this project include:

• React.js
• Hardhat
• Solidity
• Openzeppelin
• Bootstrap
• Celo-tools

(back to top)

👇 Getting Started

To get this project up running locally, follow these simple example steps.

Prerequisites

You will need node installed. If you do not have node installed, you can install it with the command below.

• npm

  npm install npm@latest -g

Installation

Step-by-step guide to running this NFT minter locally;

1. Clone the repo

   git clone https://github.com/dacadeorg/celo-nft-minter.git

2. Install NPM packages

   npm install

3. Install Hardhat

   npm install --save-dev hardhat

4. Run your application

   npm run start

Smart-Contract-Deployment

Step-by-step guide to redeploying the NFT smart contract using your address to enable you mint NFTs.

1. Compile the smart contract

   npx hardhat compile

2. Run tests on smart contract

   npx hardhat test

3. Update env file

• Create a file in the root directory called ".env"
• Create a key called MNEMONIC and paste in your mnemonic key. e.g

  MNEMONIC=asdasd adeew grege egegs nbrebe fwf vwefwf wvwvwv wevw vbtbtr wcvd

4. Deploy the smart contract

    npx hardhat run scripts/deploy.js

5. Run the project

    npm run start

(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/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

👮‍♂️ License

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

(back to top)

📱 Contact

Visit us at - Dacade

(back to top)