Skip to content

An open Marketplace where users can mint their own NFTs and list them or buy NFTs from others.

License

Notifications You must be signed in to change notification settings

Jeff1010-web/polyplace

Repository files navigation

Alt text logo

Polyplace

An open decentralized NFT Marketplace built with Solidity and Next.js, powered by Polygon Technologies. It basically is an open platform where users can mint and trade their own NFTs.

Table of Contents

The Project

An open platform where users can mint their own NFTs and list them on a Marketplace or buy NFTs from others. It includes:

  • A smart contract which represents a collection of NFTs by following the ERC-721 standard.
  • A smart contract which represents the NFT Marketplace and contains all the logic to make offers, execute offers...
  • A Next.js front-end application as a user interface.

NFTMarketplace Polygon(Mumbai Testnet) smart contract address:

https://mumbai.polygonscan.com/address/0xF5f6B924332C350E3Fcd3A50Fc94db822f0B760f

Demo video

https://www.youtube.com/watch?v=kVIb7MGJ53k&t=36s

Project details

Users can access the application via web-browser, and must have the Metamask wallet installed. The interface, built with Next.js, relies on the ethers.js library to communicate with the smart contracts through Metamask. This means that the data reflected on the front-end application is fetched from the Polygon blockchain. Each action performed by the user (mint an NFT, sell NFT, buy NFT...) creates a transaction on Polygon, which will require Metamask confirmation and a small fee, and this transaction will permanently modify the state of the NFTMarketplace smart contracts. On top of it, user's NFT Metadata will be uploaded to the IPFS, generating a hash which will be permanently recorded on the blockchain to prove ownership.

Features

Users can perform the following actions on the NFT Marketplace:

Mint

Input a name, description and upload a file (image) to mint an NFT. Once minted, a representation of this NFT will be displayed in the marketplace and it will be owned by its creator. This is open for everyone, meaning everyone can participate in this NFT creation through this platform.

Buy NFT

A user can buy NFTs which someone else offered. This will require paying the requested price and a small fee.

Sell NFT

Users can sell their NFT by specifying its price (in MATIC). If someone fulfills this offer, then the NFT and its ownership is transferred to the new owner.

Smart Contract Visualization

Below you can view the current's smart contract functions (and its interactions).

SCV

Developers

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Connect to Mumbai Testnet

First, it is required to install Metamask wallet browser extension: https://metamask.io/

Next, you need to configure Metamask to connect to the desired blockchain by using the following link: https://chainlist.org/ and add the network of your choice (Mumbai Testnet for now), by simply connecting your wallet from a test address.

Getting test MATIC

You can get up to 2 test MATIC / day by pasting your address here: https://mumbaifaucet.com/.

Install locally

First, you will need to clone or fork the repository into your Github account:

git clone https://github.com/chrisstef/polyplace.git

Run the following command in your terminal after cloning the main repo:

npm install

At this point you will be able to run the frontend with:

npm run dev

Install & Run in Docker Environment

Before you begin, you'll need to have Docker installed on your machine. If you haven't already installed it, you can follow the installation instructions for your operating system on the official Docker website: https://docs.docker.com/get-docker/

To run the app in a Docker environment, follow these steps:

  • Clone the repository to your local machine.
  • Navigate to the root directory of the project in your terminal.
  • Run the following command:
docker-compose up --force-recreate

The docker-compose up --force-recreate command starts the container defined in the docker-compose.yml file. The --force-recreate flag forces recreation of containers even if their configuration appears to be unchanged. This is useful when you want to make sure you are running the latest version of the container.

This command will start the container and map port 3000 on the container to port 3000 on your local machine. You can access the app by opening http://localhost:3000 in your web browser.

To stop the container, use Ctrl + C in your terminal and run the following command:

docker-compose down

Run with Makefile (Optional)

Makefile provides convenient shortcuts for common tasks(docker instructions in our case). It is a way of automating software building procedure and other complex tasks with dependencies. Make sure you have Makefile installed and proceed with the following commands:

## Cleans, builds and runs the dapp on the DEVELOPMENT environment
make run-dev
## Cleans & recreates everything on the DEVELOPMENT environment
make recreate-dev
## Cleans the dapp from the DEVELOPMENT environment
make clean-dev

To see the list of all the available commands:

make help

That's it! You now have the Next.js app running in a Docker container. You can make changes to the app by modifying the files in the pages directory, and the changes will be automatically reflected in the running container.

Smart Contract development

Make sure to go through the official Docs: https://hardhat.org/hardhat-runner/docs/getting-started#overview.

Initialize hardhat by running the following command:

npx hardhat

First, you will have to set up a local network by running the following command:

npx hardhat node

After you are happy with your changes in NFTMarketplace.sol file, compile the smart contract:

npx hardhat compile

Deployment on Local Blockchain

Deploy the contracts on your local hardhat network by running the following command:

npx hardhat run scripts/deploy.js --network localhost

If all goes well, a new smart contract address refering the NFT Marketplace will be generated. Paste this address in the constants.js file.

Next, remove the argument provided in the JsonRpcProvider which is located in the line 111 of the NFTContext.js file.

Finally, run the frontend on a new terminal to open the User Interface:

npm run dev

A local instance of Polyplace will be up and running on your local environment.

Tech stack

  • Solidity
  • Next.js
  • hardhat
  • ethers.js
  • node.js
  • Metamask
  • IPFS
  • Infura
  • Alchemy

Future Ideas

  • Clear deploy on Polygon Mainnet.
  • Auction features.
  • Bulk upload of NFTs as collections.
  • Creator details page.

Resources