Feducia

A CROWDFUNDING DAPP FOR SIMPLICITY
Explore the docs »

View Demo . Frontend Repo · Report Bug · Request Feature

Table of Contents

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

About The Project

Every idea's at one point in time will need to be funded. The need to make fund accessible and financial aid trouble-free has been the driving force for this project (FEDUCIA). We strive to make funding facile, transparent and accessible to anyone and everyone. We are dedicated to the principles of transparency, trust and security and have made the DApp in a way that this principles are meticulously coded into the protocol. We want to make sure that ideas become a reality and will try to make sure we play a role in securing both the interest of the funders and creator. Here are some reasons why FEDUCIA should be your goto DApp to access funding for your next project and also contribute to it success:

• IT A GOOD WAY TO TEST PUBLIC ACCEPTANCE OF AN IDEA
• IT TRANSPARENT
• IT CAN BE A FAST WAY TO RAISE MONEY
• IT IS SECURED AND NO NEED FOR TRUST (TRUSTLESS)
• IT CAN KEEP THE ANONYMITY OF THE CAMPAIGNER
• IT IS SECURED(YOUR FUNDS CAN'T BE SEIZED)
• IT CAN BE A WAY TO LOCK MONEY FOR A SPECIFIC TIME PERIOD
• LEARNING AND IMPROVING MY BLOCKCHAIN SKILLS

Of course, no one single project will serve all case since your needs may be different. So I'll be adding more features in the near future(and your help will be greatly appreciated). You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people who will contribute to expanding this Project!!!. May The Force Be With You.

(back to top)

Built With

This project was built with the following technologies( as of the time of the last update of this readme file and in no order of importance).

• Solidity
• Hardhat
• Polygon
• Javascript
• Firebase
• Chainlink
• Tailwindcss

(back to top)

Getting Started

Below is how to get started with this project.

## Requirements

See the requirements for this project click here.

Installation

• First clone the project into your local machine.

git clone https://github.com/UpgradeOfficial/feducia.git

• Go to the repository.

cd feducia

• install dependencies.

yarn install

• Copy the example.env file to .env and fill in the values.

cp example.env .env

• The .env file should look like this:

PRIVATE_KEY=your_private_key
MUMBAI_RPC_URL=your_mumbai_rpc-_url
GOERLI_RPC_URL=your_goerli_rpc-_url
ETHERSCAN_API_KEY=your_etherscan_api_key
UPDATE_FRONT_END=<true/false> // Update the ABI and CONTRACT-ADDRESS when deployed on the frontend.

• Deploy to network e.g localhost, mumbai, goerli e.t.c

yarn hardhat deploy --network <name_of_network>

• Test the DApp

yarn hardhat test --network <name_of_network>

• Generate Coverage Report (>90%)

yarn hardhat coverage --network <name_of_network>

Interact with the contract

• Create a campaign:

 yarn hardhat launch --name "Startup Fund" --goal 100 --start-at 1668455498 --end-at 1668460778 --network <name_of_network>

• Get campaign information

  yarn hardhat getCampaign --id 1 --network <name_of_network>

Note: Other functions/task can be seen in the tasks Folder of the contract

(back to top)

Usage

This app can be used and intaract in various ways

• It can be used via etherscan
• It can be used via the react app
• Download the project and run the tasks to interact with contract

(back to top)

Roadmap

• Think the Hackathon Idea
• Create the contract
• Test The Contract
• Create Task to interact with the contract
• Deploy the contract
• Creat a frontend for the contract
• Deploy the frontend
• Test the frontend (create campaign and test the various functions)

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.txt for more information.

(back to top)

Contact

• twitter - @IncreaseOdeyemi
• email - odeyemiincrease@yahoo.com
• phone no. - 07068448786 (whatsapp)
• Project Link: https://github.com/UpgradeOfficial/feducia

(back to top)

Acknowledgments

Special acknolegment to the following people/company/organisation:

• Odeyemi Increase Ayobami (creator)
• Polygon (Layer-2 Blockchain/Organiser)
• Xend (hackathon_Host/Organiser)
• Tutors/Admin and fellow students on the discord channel who were ever willing and ready to answer the never ending questions. May the force be will you all.

(back to top)