https://github.com/nour-karoui/nft-auction
An auction platform that allows you to put into auction your NFTs and participate in auctions in order to win NFTs.
https://github.com/nour-karoui/nft-auction
blockchain erc1155 ethersjs nft-marketplace opensea-api smart-contracts solidity web3
Last synced: 3 months ago
JSON representation
An auction platform that allows you to put into auction your NFTs and participate in auctions in order to win NFTs.
- Host: GitHub
- URL: https://github.com/nour-karoui/nft-auction
- Owner: nour-karoui
- License: mit
- Created: 2023-02-15T19:11:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-19T10:50:04.000Z (about 2 years ago)
- Last Synced: 2025-01-08T07:09:50.972Z (4 months ago)
- Topics: blockchain, erc1155, ethersjs, nft-marketplace, opensea-api, smart-contracts, solidity, web3
- Language: TypeScript
- Homepage: http://auction-cienne.s3-website.eu-central-1.amazonaws.com/
- Size: 2.61 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
HELLO 
This is Auction-cienne
---
## ✂️ How is this project divided?
The project is divided into 2 main sections:
1. ***Auction-truffle:*** The truffle project, containing all the smart contracts used for this project and their deployments configurations.
2. ***Auction's platform:*** The Dapp that allows users to auction with their NFT and participate in open auctions. [*Visit Auction-cienne*](http://auction-cienne.s3-website.eu-central-1.amazonaws.com/)
## 🙌 What is Auction-cienne?
It is a **decentralized app for NFT auction** hosted on **Goerli Testnet** built with ***Truffle Framework***, ***ReactJs*** and ***ethers.js*** library.
1. Any user can put his owned NFTs into auction.
2. Any user can participate in the auction and bid on an NFT.
3. The auction lasts 72 hours and gets 6 more hours with every bid more than 0.5 ETHER.
4. The first bidder wins after 12 hours without bids, the next bidders win after 6 hours only.
## 🎯 Running and Testing the project
> **In order to just run the DApp, you can skip this section since the smart contracts are already deployed. This section is for those who want to run, modify and test the smart contracts whether locally or in a testnet**
After cloning this repo, we will start with running and testing the blockchain part.
### 📒 The blockchain part
---
> Deploying the contract on a Testnet takes more time than deploying it locally so be patient.
Make sure to create .env file following the **.env.example** file
Run this command to install dependencies:
```shell
cd auction-truffle
npm install
```
**These are the main commands that would help you interact with our smart contracts:**
1. Compiling the contracts (this will generate a JSON file for each contract found in build/contracts)
```shell
truffle compile
```
2. Deploying the contracts
```shell
truffle migrate --network
truffle run verify
```
3. Interacting with the contracts
```shell
truffle console --network
```
### 🚀 Running The Auction-cienne's DApp
---
> **To run the DApp you need both a Metamask wallet attached to your Browser, and owned NFTs on Opensea, also you need some Goerli Ether**
> You can get some Goerli ETH on [This Faucet](https://goerlifaucet.com/).
> You can create an NFT on [Testnet Opensea](https://testnets.opensea.io/asset/create).
#### Running the DApp
To interact with the auction-cienne app
```shell
npm start
```
## 🔨 Areas of Improvements
1. Automating the contract deployment and integration with frontend (updating ABI and address).
2. Add unit tests to both smart contract and frontend.
3. Add events to smart contract and event listening to frontend.
4. Automate the process of transferring NFT at the end of the auction, (with chainlink client for eg).