jonathanjander / nft-react-postcard-minter

This is a prototype for my bachelors thesis project. It is about how NFTs might help SIDS (Small Island Developing States) financially

Table of Contents

1. About The Project
2. Set up for testing
3. Testing it
4. Installation
5. Contact
6. Acknowledgments

About The Project

Souvenir-Minter-DApp

This is a bachelors thesis project. A DApp which allows you to configure and mint Souvenir-NFTs. The thesis is about SIDS (Small Island Developing States) and how they might use NFTs as a possible source of income. For that, two protoypes were created. One prototype for the NFT collection and one prototype for an accompanying decentralised system to mint so-called Souvenir-NFTs.

This repo is archived. Which means, it is read-only. If you want to try it out locally, please fork this repository.

Set up for testing

1. In order to test the DApp, you need to have a web3 provider like MetaMask. It was only tested with the MetaMask browser extension, so preferably use that.

2. Create a MetaMask account and sign up over the browser extension. It only works if you're logged in over the browser extension.

   

3. Open the Souvenir-Minter-DApp.

4. You should get a MetaMask notification to connect one of your Ethereum accounts to the website.

   

5. After successfully connecting your Ethereum account to the website, you should get asked to switch networks to the Rinkbey test network because that is the only public network with a deployed Souvenir Smart Contract. You should get a MetaMask notification to connect one of your Ethereum accounts to the website. If not, press the "Connect to Rinkeby" button shown on the website.

   

6. You need ETH (Ether) on Rinkeby in order to pay for transactions.

   • rinkebyfaucet.com (only works once a day)
   • faucets.chain.link/rinkeby (you need to connect your Ethereum account to this site if you want to get Rinkeby ETH with this method)
   • ask me to send you some Rinkeby ETH (email: [email protected])

7. If you see the Frontend of the website, then it worked! MetaMask should look like this:

   

8. Only follow this step if you want to test the DApp locally aswell (not recommended because some features are missing locally)

   • install Ganache
   • create a new workspace with the Quickstart function on ganache
   • Add the local network to MetaMask (RPC-URL is HTTP://127.0.0.1:7545 and the Chain ID is 1337)

Testing it

Fill out the form. Name, Description and Asset are required fields. In order to use the OpenSea representation, use one of the following supported file formats for the Asset File: gif, jpg, png, svg, mp4, mp3, WebM, wav, glb, ogg, gltf

The file can't be bigger than 100MB.

You can mint up to 20 token copies at a time. The royalty fees can go between 0% and 30% Add as many property fields as you like.

After pressing the "mint" button, wait for MetaMask to ask for your digital signature. It takes some time until the transaction is confirmed.

Once confirmed, you should see a status message telling you that the transaction was successful.

You might have to wait a bit until you're able to view the NFT on OpenSea. That is because of the IPFS network delay.

Built With

• Truffle Suite (Truffle, Ganache)
• React.js
• React Bootstrap
• Node.js
• Chai.js
• OpenZeppelin Smart Contract Library

(back to top)

Installation

This is for if you want to try it out locally.

1. Get your free API Keys at Pinata (IPFS)
2. Get your free API Keys at Etherscan
3. Create a Project (Endpoint=Rinkeby) and get your free API Keys at Infura
4. Get the MetaMask browser Extension and create an account
5. Create an Ethereum Account on MetaMask and get your Mnemonic, public and private key for later
6. Clone the repo

   git clone https://github.com/jonathanjander/bachelors-thesis.git

7. Install NPM packages

   npm install

8. Enter your API in .env

   REACT_APP_PINATA_API_KEY="YOUR_PINATA_KEY"
   REACT_APP_PINATA_API_SECRET="YOUR_PINATA_SECRET"
   REACT_APP_PINATA_FILE_ENDPOINT="https://api.pinata.cloud/pinning/pinFileToIPFS"
   REACT_APP_PINATA_JSON_ENDPOINT="https://api.pinata.cloud/pinning/pinJSONToIPFS"
   
   REACT_APP_ETHERSCAN_API_KEY="YOUR_ETHERSCAN_KEY"
   REACT_APP_ETHERSCAN_ENDPOINT_PREFIX="https://api-rinkeby.etherscan.io/api"
   
   REACT_APP_MNEMONIC="YOUR_METAMASK_MNEMONIC"
   REACT_APP_ETH_CLIENT_URL="https://rinkeby.infura.io/v3/YOUR_INFURA_PROJECT_ID"
   
   REACT_APP_PUBLIC_KEY = "YOUR_ETH_ACCOUNT_PUBLIC_KEY"
   REACT_APP_PRIVATE_KEY = "YOUR_ETH_PRIVATE_KEY"

9. To start the DApp locally

   npm run start 

(back to top)

Contact

Jonathan Jander - [email protected]

(back to top)

Acknowledgments

• GitHub Pages
• Dapp University
• Dievardump

(back to top)