web3-Ecommerce-dapp

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

web3-Ecommerce-dapp

(★ 20)

Amazon like e-commerce Dapp with open sales, customized stores, auctions system and product reviews built on the EVM blockchains

web3-Ecommerce-dapp Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Decentralized Marketplace Dapp V2

This is my second implementation of a decentralized E-commerce marketplace built on top of EVM-compatible Blockchains such as Ethereum and Polygon. The previous dapp only allowed users to buy and sell single items without quantity. However, this new version is much more advanced and includes a wide range of features. Users can now create their own stores with customized branding and sell products with limited or unlimited quantities. Additionally, buyers have the ability to review the products they purchase. I have also introduced an Auction market, inspired by popular NFT marketplaces like OpenSea, however my implementation is more generalized and accepts a variety of products. It's important to note that all payments within the marketplace remain with cryptocurrency tokens.

### Built With

* [Solidity](https://docs.soliditylang.org/)
* [Brownie](https://eth-brownie.readthedocs.io)
* [React.js](https://reactjs.org/)
* [ethers.js](https://docs.ethers.io/v5/)
* [web3modal](https://github.com/Web3Modal/web3modal)
* [material ui](https://mui.com/getting-started/installation/)

<details>
 <summary>Table of Contents</summary>
 <ol>
 <li>
 <a href="#getting-started">Getting Started</a>
 <ul>
 <li><a href="#prerequisites">Prerequisites</a></li>
 <li><a href="#installation">Installation</a></li>
 </ul>
 </li>
 <li>
 <a href="#how-it-works">How it Works</a>
 <ul>
 <li><a href="#main-market">Main Market</a></li>
 <li><a href="#the-store">The Store</a></li>
 <li><a href="#auction-market">Auction Market</a></li>
 </ul>
 </li>
 <li>
 <a href="#how-to-use">How to Use</a>
 <ul>
 <li><a href="#scripts">Scripts</a></li>
 <li><a href="#testing">Testing</a></li>
 <li><a href="#front-end">Front End</a></li>
 </ul>
 </li>
 <li><a href="#contact">Contact</a></li>
 <li><a href="#license">License</a></li>
 </ol>
</details>

## Getting Started

### Prerequisites

Please install or have installed the following:
* [nodejs and npm](https://nodejs.org/en/download/) 
* [python](https://www.python.org/downloads/)
* [MetaMask](https://chrome.google.com/webstore/detail/metamask/nkbihfbeogaeaoehlefnkodbefgpgknn) Chrome extension installed in your browser

### Installation

1. Installing Brownie: Brownie is a python framework for smart contracts development,testing and deployments. It's quit like [HardHat](https://hardhat.org) but it uses python for writing test and deployements scripts instead of javascript.
 Here is a simple way to install brownie.
 ```
 pip install --user pipx
 pipx ensurepath
 # restart your terminal
 pipx install eth-brownie
 ```
 Or if you can't get pipx to work, via pip (it's recommended to use pipx)
 ```
 pip install eth-brownie
 ```
 Install [ganache-cli](https://www.npmjs.com/package/ganache-cli): 
 ```sh
 npm install -g ganache-cli
 ```
 
3. Clone the repo:
 ```sh
 git clone https://github.com/kaymen99/MarketPlace-Dapp-V2.git
 cd MarketPlace-Dapp-V2
 ```
3. Install Ganache:
 Ganache is a local blockchain that run on your machine, it's used during development stages because it allows quick smart contract testing and avoids all real Testnets problems. 
 You can install ganache from this link : https://trufflesuite.com/ganache/
 
 Next, you need to setup the ganache network with brownie :
 ```sh
 brownie networks add Ethereum ganache-local host=http://127.0.0.1:7545 chainid=5777
 ```
4. Set your environment variables
 To be able to deploy to real testnets you need to add your PRIVATE_KEY (You can find your PRIVATE_KEY from your ethereum wallet like metamask) and the infura project Id (just create an infura account it's free) to the .env file:
 ```
 PRIVATE_KEY=<PRIVATE_KEY>
 WEB3_INFURA_PROJECT_ID=<< YOUR INFURA PROJECT ID >>
 ```
 You can choose to use ethereum testnets like rinkeby, Kovan or any other evm compatible testnet.
 You'll also need some eth in the testnet. You can get it into your wallet by using a public faucet.

5. As infura recently removed its free IPFS gateway i used `web3.storage` api for storing data into IPFS, this api is as simple as infura it requires the creation of a free account and a new api token which you can do [here](https://web3.storage), when you finish add your api token into the `src/utils/ipfsStorage.js` file:
 ```js
 const web3storage_key = "YOUR-WEB3.STORAGE-API-TOKEN";
 ```
 
(<a href="#top">back to top</a>)

## How it Works

### Main Market

This is the core of the old version [marketplace V1](https://github.com/Aymen1001/MarketPlace-dapp) and it's made for single items purchase , User can add a product by providing the product name, description, price in $ and image.

![Capture d’écran 2022-03-03 à 22 36 53](https://user-images.githubusercontent.com/83681204/156660595-9432f950-941d-465f-ad69-bb0edaad32b7.png)

The platform ensures a good interaction between the seller and the buyer by deviding the purchase process (product state) into 4 steps:
 <ul>
 <li>In Sale: The first step when a seller list it's product on the market </li>
 <li>Pending: When a product is bought the amount paid is locked in the smart contract and buyer waits for seller to sent the product </li>
 <li>Sent: The seller sends the product and waits for the buyer confirmation</li>
 <li>Sold: The buyer confirms the recieval and the funds are transfered to the seller </li> 
 </ul>
 
All this steps can be performed on the product page:

<table>
 <tr>
 <td style="text-align:center;">Seller Point of view </td>
 <td style="text-align:center;">Buyer Point of view </td>
 </tr>
 <tr>
 <td valign="top"><img src="https://user-images.githubusercontent.com/83681204/156660145-aacb1ff4-2ba3-44d5-8bb9-87c927571b6b.png"></td>
 <td valign="top"><img src="https://user-images.githubusercontent.com/83681204/156660202-5bbb40db-ccf6-4a9f-88eb-3b407eca0211.png"></td>
 </tr>
 </table>

### The Store

The dapp enables sellers to create their own order based stores, They can add limited and unlimited quantity products.

Store Page:

Seller Dashboard:

Each seller willing to create a new store must provide a name and the store logo:

On the product page you can find all details regarding the product(seller, quantity, price,...) and the reviews posted by previous buyers,
When an order is created it goes through 3 main states: 
<ul>
 <li>PENDING: just created and waiting for seller acceptance</li>
 <li>SENT: product sent and waiting for buyer recieval confirmation</li>
 <li>COMPLETED: The order is complete so seller recieve payment and buyer can leave a review </li> 
</ul>

![store-product-page](https://user-images.githubusercontent.com/83681204/161357125-2a1cb716-be24-4382-8708-23d930afc983.png)

### Auction Market

User can start an auction for any type of products by providing name, description, starting price, auction duration (in hours), item image.
Bidders can offer an initial bid and outbid if necessary without having to withdraw their fund on each bid, the highest bidder will be determined after the end of the auction clock

(<a href="#top">back to top</a>)

## How to Use

### Scripts

In the MarketPlace-Dapp-V2 folder you'll find a directory scripts, it contain all the python code for deploying your contracts and also some useful functions

The reset.py file is used to remove all previous contracts deployments from build directory:
 ```sh
 brownie run scripts/reset.py
 ```
 The deploy.py file allow the deployment to the testnet/local-network:
 ```sh
 brownie run scripts/deploy.py --network=ganache-local
 ```
 The update_front_end.py is used to transfer all the smart contracts data (abi,...) and addresses to the front end in the artifacts directory:
 ```sh
 brownie run scripts/update_front_end.py
 ```
 
 After running this 3 cammands, the MarketPlace contract is now deployed and is integrated with the front end
 
 (<a href="#top">back to top</a>)
 
 ### Testing

In the MarketPlace-Dapp-V2 folder you'll find a directory tests, it contain all the python code used for testing the smart contract functionalities
 
 You can run all the tests by :
 ```sh
 brownie test
 ```
 Or you can test each function individualy:
 ```sh
 brownie test -k <function name>
 ```
 
(<a href="#top">back to top</a>)
 
### Front-end
 
 The user interface of this application is build using React JS, it can be started by running: 
 ```sh
 cd front-end
 yarn
 yarn start
 ```
 It uses the following libraries:
 <ul>
 <li>Ethers.js: used as interface between the UI and the deployed smart contract</li>
 <li>Web3modal: for conecting to Metamask</li>
 <li>ipfs-http-client: for connecting and uploading files to IPFS </li>
 <li>@reduxjs/toolkit & redux-persist: for managing the app states (account, balance, blockchain) </li>
 <li>Material UI: used for react components and styles </li> 
 </ul>

(<a href="#top">back to top</a>)

## Contact

If you have any question or problem running this project just contact me: aymenMir1001@gmail.com

(<a href="#top">back to top</a>)

## License

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

(<a href="#top">back to top</a>)

web3-Ecommerce-dapp

web3-Ecommerce-dapp Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

web3-Ecommerce-dapp

web3-Ecommerce-dapp Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README