Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moonman369/crowd-funding-contract

This is a crowd funding smart contract.
https://github.com/moonman369/crowd-funding-contract

Last synced: about 6 hours ago
JSON representation

This is a crowd funding smart contract.

Awesome Lists containing this project

README 

        
# Crowd Funding Contract






[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]










## About The Project



This is a simple hardhat project implementing the functionalities of an Ethereum based Crowdfunding Platform.



### Built With



* [![Ethereum][Ethereum.org]][Ethereum-url]

* [![Solidity][Solidity.org]][Solidity-url]

* [![Hardhat][Hardhat.org]][Hardhat-url]

* [![Ethers][Ethers.js]][Ethers-url]










## Getting Started



This is an example of how you may give instructions on setting up your project locally.

To get a local copy up and running follow these simple example steps.



### Prerequisites



These are the list of packages required to run this project locally.



* Node

  ```sh

  node v16.x.x

  ```

* npm

  ```sh

  npm install npm@latest -g

  ```

  
(back to top)


  


### Installation



Follow these steps to locally install the project and its dependencies.



1. Clone the repo

   ```sh

   git clone -b main https://github.com/moonman369/Crowd-Funding-Contract.git

   ```

2. Install NPM packages

   ```sh

   npm install

   ```

(back to top)









## Usage



You can use the following commands to explore the functionality of this project.



### 1. **Run Local Node**



Run this command to start a local node at http://localhost:8545. Run this command in a separate terminal before running the following commands.

```sh

npm run node

```





### 2. **Compile Contract**



Run this command to compile all the contracts.

```sh

npm run compile

```





### 3. **Unit Testing**



Run this command to run all tests for the contract.

```sh

npm run test

```





### 4. **Deploy Non-upgradable Contract**



Run this command to deploy contract to local development blockchain.

```sh

npm run deploy-local

```





### 5. **Deploy Upgradable Proxy Contract**



Run this command to deploy proxy contract to local development blockchain.

```sh

npm run deploy-proxy-local

```





### 6. **Upgrade Proxy Contract**



Run this command to upgrade proxy contract.

```sh

npm run upgrade-proxy-local

```

(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 **GPL-3.0** License. See `LICENSE.txt` for more information.



(back to top)







## Contact



Twitter: [coin_sniper356](https://twitter.com/coin_sniper356)



LinkedIn: [Ayan Maiti](https://www.linkedin.com/in/ayan-maiti-5b4332233/)



Email: [[email protected]](mailto:[email protected])



Project Link: [https://github.com/moonman369/Crowd-Funding-Contract](https://github.com/moonman369/Crowd-Funding-Contract)



(back to top)



[contributors-shield]: https://img.shields.io/github/contributors/moonman369/Crowd-Funding-Contract.svg?style=for-the-badge

[contributors-url]: https://github.com/moonman369/Crowd-Funding-Contract/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/moonman369/Crowd-Funding-Contract.svg?style=for-the-badge

[forks-url]: https://github.com/moonman369/Crowd-Funding-Contract/network/members

[stars-shield]: https://img.shields.io/github/stars/moonman369/Crowd-Funding-Contract.svg?style=for-the-badge

[stars-url]: https://github.com/moonman369/Crowd-Funding-Contract/stargazers

[issues-shield]: https://img.shields.io/github/issues/moonman369/Crowd-Funding-Contract.svg?style=for-the-badge

[issues-url]: https://github.com/moonman369/Crowd-Funding-Contract/issues

[license-shield]: https://img.shields.io/github/license/moonman369/Crowd-Funding-Contract.svg?style=for-the-badge

[license-url]: https://github.com/moonman369/Crowd-Funding-Contract/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://www.linkedin.com/in/ayan-maiti-5b4332233/

[product-screenshot]: images/screenshot.png

[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white

[Next-url]: https://nextjs.org/

[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB

[React-url]: https://reactjs.org/

[Ethers.js]: https://img.shields.io/badge/Ethers.js-00047F?style=for-the-badge&logo=ethersdotjs&logoColor=4FC08D

[Ethers-url]: https://docs.ethers.io/v5/



[Chainlink.org]: https://img.shields.io/badge/Chainlink-4A4A55?style=for-the-badge&logo=chainlink&logoColor=0B4EE0

[Chainlink-url]: https://chain.link/

[Ethereum.org]: https://img.shields.io/badge/Ethereum-2DC39C?style=for-the-badge&logo=ethereum&logoColor=D9E029

[Ethereum-url]: https://ethereum.org/en/

[Hardhat.org]: https://img.shields.io/badge/Hardhat-D8E00B?style=for-the-badge&logo=hardhat&logoColor=white

[Hardhat-url]: https://hardhat.org/

[Solidity.org]: https://img.shields.io/badge/Solidity-563D7C?style=for-the-badge&logo=solidity&logoColor=black

[Solidity-url]: https://docs.soliditylang.org/en/v0.8.17/