A crowdfunding decentralised app built on the ethereum blockchain.
View Demo
·
Report Bug
·
Request Feature
Table of Contents
This is a hardhat build of a simple web3 app that stores a number to the blockchain.
Follow these instructions to get set up locally.
- Install yarn.
- yarn
npm install yarn -g
- Create an account on Alchemy.
-
Get a free Etherscan API Key at https://etherscan.io
-
Get a free Coinmarketcap API Key at https://pro.coinmarketcap.com
-
Clone the repo
git clone https://github.com/Theracon/crowdfunder.git
-
Install packages
yarn
-
Enter your API & wallet KEYS and other variables in your
.env
fileRINKEBY_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" REPORT_GAS_ENABLED="SOME VALUE" REPORT_GAS_COLORED="SOME VALUE"
Open a terminal in the project directory and run the following commands:
yarn compile
yarn 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:
- rinkeby
- localhost
For more usage examples, please refer to the Documentation
- To run unit tests (local node):
yarn test
- To run staging tests (rinkeby testnet):
yarn test:staging
- 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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.md
for more information.
Ashraf Yusuf - @ashrafofficia1 - hello@ashraf.me
Project Link: https://github.com/Theracon/hardhat-simple-storage
Here are some of the tools/plugins that made this project possible: