Hardhat Simple Storage

A decentralized app that takes and stores a number on the ethereum blockchain.

View Demo · Report Bug · Request Feature

About The Project

This is a hardhat build of a simple web3 app that stores a number to the blockchain.

Built With

Getting Started

Follow these instructions to get set up locally.

Prerequisites

  1. Install yarn.
  • yarn
    npm install yarn -g
  1. Create an account on Alchemy.

Installation

  1. Get a free Etherscan API Key at https://etherscan.io

  2. Get a free Coinmarketcap API Key at https://pro.coinmarketcap.com

  3. Clone the repo

    git clone https://github.com/Theracon/hardhat-simple-storage.git
  4. Install packages

    yarn
  5. Enter your API & wallet KEYS in your .env file

    RINKEBY_RPC_URL="https://eth-rinkeby.alchemyapi.io/v2/YOUR-UNIQUE-KEY"
    RINKEBY_PRIVATE_KEY="ENTER YOUR PRIVATE KEY"
    ETHERSCAN_API_KEY="ENTER YOUR ETHERSCAN API KEY"
    COINMARKETCAP_API_KEY="ENTER YOUR COINMARKETCAP API KEY"

Usage

Open a terminal in the project directory and run the following commands:

yarn hardhat compile
yarn hardhat node

In a new terminal, run the following command:

yarn hardhat run scripts/deploy.js --network [network-name]

Networks names that are config to use in this project are:

  • hardhat
  • rinkeby
  • localhost

For more usage examples, please refer to the Documentation

Testing

yarn hardhat test

Roadmap

  • Add Changelog
  • Add back to top links
  • Multi-language Support
    • Hindi
    • Spanish

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Ashraf Yusuf – @ashrafofficia1[email protected]

Project Link: https://github.com/Theracon/hardhat-simple-storage

Acknowledgments

Here are some of the tools/plugins that made this project possible:

GitHub

View Github