Table of contents

• Overview
• Project Features
• Technologies
• Repo Setup
• Requirements
• Setup the Project
• Install Hardhat
• Env Setup
• Setup Hardhat.config
• Create the SmartContract
• Compile
• Deploy
• Verify
• Setup the Frontend
• Install Dependencies
• Start Server
• Build the Frontend
• Testing the Smartcontract
• DEES Contract Address
• Live Link
• Contributors
• Contributing to the project

Overview

This is a project by Team Call-Byte presented for the chainlink spring 2022 hackathon.

This is a digital decentralized library marketplace that allows users to upload files, retrieve files in their private library, share files with other users from the service. It also allows users to put their files up for public sales and make money from it.

We have integrated the use of Chainlink Price Feed to help Lebium communicate with live changing prices of ETHUSD to accurately represent items up for public sale.

We wanted people to have a safe secure private and permanent place to store private digital items like files, secretes etc, we also wanted people to be able to make money of the digital items they wish to make public, hence the public library market.

Project Features

• Upload files.

• Retrieve files.

• Share files to other users.

• Put files up for public sales.

• Buy items from users.

Technologies

Repo Setup

To setup the repo, fork Lebium repo, then clone the forked repository to create a copy on the local machine.

$ git clone https://github.com/{GitHub-Username}/Digital-Library-Marketplace.git

Change directory to the cloned repo and set the original repository as the "upstream" and your forked repository as the "origin" using terminal.

$ git remote add upstream https://github.com/Epic-Byte/Digital-Library-Marketplace.git

Requirements

• Hardhat
• Alchemy key
• Metamask key
• Etherscan.io API Url
• Node JS

Setup the Project

These are the steps involved in setting up this project

Install Hardhat

The first step involves cloning and installing hardhat.

$ cd Digital-Library-Marketplace
 
$ npm i -D hardhat
 
$ npm install
 
$ npm install --save-dev "@nomiclabs/hardhat-waffle" "ethereum-waffle" "chai" "@nomiclabs/hardhat-ethers" "ethers" "web3" "@nomiclabs/hardhat-web3" "@nomiclabs/hardhat-etherscan" "@openzeppelin/contracts" "dotenv"
 
# If you encounter errors installing the dependencies above, delete the old package-lock.json and run the `npm install --save-dev` command again

Env Setup

Next create a .env file by using the sample.env. Retrieve your information from the relevant sites and input the information where needed in the .env file.

To retrieve your metamask private key.

• Open your account details by clicking on the three dots on the metamask extension on your chrome browser
• Click on export private key
• Verify your password
• Copy your private key and place it in the .env file

To retrieve your alchemy key.

• Login to your account on https://www.alchemy.com/
• Once youre redirected to your dashboard, click on create app.
• Fill in the relevant details especially the chain and network
• Once the app has been created, click on view key.
• Copy the HTTP and place it in the .env file.

To retrieve your etherscan key.

• Login to etherscan and hover over the dropdown arrow for your profile on the navbar.
• Click on API keys and add to create a new project (optional step).
• Once the project has been created, click on the copy button to copy the API key.
• Paste it in the .env file

Setup Hardhat.config

Below is the setup for the hardhat.config.json

Create the SmartContract

• First write the Smartcontract codes within the contracts folder.
• The next step involves the compilation, deployment and verification of the contract on the testnet.

Compile

• To compile the smartcontract before deployment:

$ npx hardhat compile

Deploy

• To deploy the smartcontract:

$ npx hardhat run packages/hardhat/deploy/01_Library.js --network rinkeby

Verify

• To verify the smartcontract:

$ npx hardhat verify 0xcdb25aa30af6bbe029e8348cad9a0d37293c0c85 --network rinkeby

Setup the Frontend

• First run the frontend on your local server to ensure it's fully functional before building for production.

Install Dependencies

• Setup and install dependencies

$ cd react-app
 
$ npm install
 
$ npm install react-scripts@latest

Start Server

• Start the server on localhost

$ npm run start

Build the Frontend

• Create an optimized production build, which can be hosted on sites like Heroku, Netlify, Surge etc.

$ npm run build

Contract Address

• https://rinkeby.etherscan.io/address/0xcdb25aa30af6bbe029e8348cad9a0d37293c0c85#code

Live Link

• http://lebium-beta.surge.sh/

Contributors

This Project was created by the members of Call Byte during the 2022 Chainlink Spring Hackathon.

GitHub Usernames

• GbolahanAnon
• Godhanded
• Bori7
• kingzamzon
• frankudoags

Contributing to the project

If you find something worth contributing, please fork the repo, make a pull request and add valid and well-reasoned explanations about your changes or comments.

Before adding a pull request, please note:

• Your contributions should be inviting and clear.
• Any addition should be relevant.
• New features should be easy to contribute to.

All suggestions are welcome!

README Created by GbolahanAnon for Call Byte