Theracon / smart-contract

A smart contract built on the Ethereum blockchain.

CrowdFunder

A crowdfunding decentralised app built on the ethereum blockchain.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Testing
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

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

Built With

• Solidity
• Hardhat
• Ethers.js
• JavaScript

(back to top)

Getting Started

Follow these instructions to get set up locally.

Prerequisites

1. Install yarn.

• yarn

  npm install yarn -g

2. Create an account on Alchemy.

• 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/crowdfunder.git

4. Install packages

   yarn

5. Enter your API & wallet KEYS and other variables in your .env file

   RINKEBY_RPC_URL="https://eth-rinkeby.alchemyapi.io/v2/YOUR-UNIQUE-KEY"
   RINKEBY_PRIVATE_KEY="<YOUR PRIVATE KEY>"
   ETHERSCAN_API_KEY="<YOUR ETHERSCAN API KEY>"
   COINMARKETCAP_API_KEY="<YOUR COINMARKETCAP API KEY>"
   REPORT_GAS_ENABLED="<SOME VALUE>"
   REPORT_GAS_COLORED="<SOME VALUE>"

(back to top)

Usage

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

yarn compile
yarn node

In a new terminal, run the following command:

hh deploy --network [network-name]

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

• rinkeby
• localhost

For more usage examples, please refer to the Documentation

(back to top)

Testing

• To run unit tests (local node):

hh test

• To run staging tests (rinkeby testnet):

hh test --network [network-name]

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).

(back to top)

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

(back to top)

License

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

(back to top)

Contact

Ashraf Yusuf - @ashrafofficia1 - [e-mail]

Project Link: https://github.com/Theracon/smart-contract

(back to top)

Acknowledgments

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

• Choose an Open Source License
• Chai
• Mocha
• Hardhat Gas Reporter
• Prettier
• Prettier Plugin Solidity
• Solidity Coverage

(back to top)