-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
46 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,47 @@ | ||
# NPB_NFT | ||
A Marketplace for NFT to sell and buy NFT's for Artists, Enthusiasts and Collectors. | ||
# NFT Marketplace | ||
|
||
USE npm i to install the dependencies | ||
and npm start to run the project. | ||
## Technology Stack & Tools | ||
|
||
- Solidity (Writing Smart Contract) | ||
- Javascript (React & Testing) | ||
- [Ethers](https://docs.ethers.io/v5/) (Blockchain Interaction) | ||
- [Hardhat](https://hardhat.org/) (Development Framework) | ||
- [Ipfs](https://ipfs.io/) (Metadata storage) | ||
- [React routers](https://v5.reactrouter.com/) (Navigational components) | ||
|
||
## Requirements For Initial Setup | ||
- Install [NodeJS](https://nodejs.org/en/), should work with any node version below 16.5.0 | ||
- Install [Hardhat](https://hardhat.org/) | ||
|
||
## Setting Up | ||
### 1. Clone/Download the Repository | ||
|
||
### 2. Install Dependencies: | ||
``` | ||
$ cd nft_marketplace | ||
$ npm install | ||
``` | ||
### 3. Boot up local development blockchain | ||
``` | ||
$ cd nft_marketplace | ||
$ npx hardhat node | ||
``` | ||
|
||
### 4. Connect development blockchain accounts to Metamask | ||
- Copy private key of the addresses and import to Metamask | ||
- Connect your metamask to hardhat blockchain, network 127.0.0.1:8545. | ||
- If you have not added hardhat to the list of networks on your metamask, open up a browser, click the fox icon, then click the top center dropdown button that lists all the available networks then click add networks. A form should pop up. For the "Network Name" field enter "Hardhat". For the "New RPC URL" field enter "http://127.0.0.1:8545". For the chain ID enter "31337". Then click save. | ||
|
||
|
||
### 5. Migrate Smart Contracts | ||
`npx hardhat run src/backend/scripts/deploy.js --network localhost` | ||
|
||
### 6. Run Tests | ||
`$ npx hardhat test` | ||
|
||
### 7. Launch Frontend | ||
`$ npm run start` | ||
|
||
License | ||
---- | ||
MIT |