Genuine-Charity-Application

🤔 About Project

Create a Transparent Charity System using Smart Contracts on Ethereum.

STATUS

• THIS PROJECT IS INCOMPLETE AND SHOULD ONLY BE USED FOR LOGICAL AND FUNDAMENTAL UNDERSTANDING PURPOSE.
• THE SOLIDITY CODE IS WRITTEN IN OLD VERSION SO REWRITING IT IN NEW VERSION IS RECOMMENDED.
• THE FRONTEND IS READY.
• THE SMART CONTRACT IS NOT CONNECTED TO THE REACT APP.
• THE SMART CONTRACT WORKS EXCEPT SOME LOGICAL ERRORS PROBABLY DUE TO THE ISSUES IN THE OLD VERSION USED TO BUILD THIS PROJECT

👨‍💻 Team members

• Shreyas Penkar
• Jainam Dharod
• Purva Anjarlekar
• Aishwarya Harkare
• Rohan Sawai
• Santanu Kumar

🙏 Mentors

• Pratim Ugale
• Shivani Pawar

🔗The Design of Charity System Based on Blockchain

The charity system mode proposed is shown in the Figure below. There are four roles: donors, beneficiaries, charity organizations and cooperative stores. The charity organizations get the information of seek help and create charity projects through the platform. Donors learn about charity projects on the platform, then donate to beneficiaries or the charity organizations. Beneficiaries upload their information to the platform for help, they can get and spend tokens in cooperative stores. The transactions occurred in the stores will be uploaded to the charity platform. The cooperative stores supply services or goods to the beneficiaries to obtain tokens. The tokens can be exchanged for real money by charity organizations.The flow of funds has been fully recorded on the blockchain, which allows transactions to be tracked and funds prevented from being abused.

Platform Usage Process

1. Donor After successful login, the donor browses the charity projects and select one project to be donated. The system will check the balance of donor account. If the balance is insufficient, the user will be reminded to deposit.Donation can be completed only the balance is sufficient.
2. People in need The people who need help should fill in the rescue information which will be uploaded to the charity organization for review, and the approved projects will be posted on the charity platform. The beneficiary can check the account balance to know the project status, and then use the tokens in cooperative shops to obtain services or products.
3. Cooperative shops The shops provides the corresponding services or goods such as medicines or books to the beneficiaries to obtain tokens.they can exchange tokens for real money by charity organizations.
4. Charity organization The organization can get donation from the platform to help other people and apply money to the cooperative shops for token exchanging

Dapp Model

Following functions have been met:

1. Beneficiary initiates a charity project in the DApp.
2. Beneficiary requests funds from the charity project initiated by himself.
3. Donor donates to the charity projects which he chooses.
4. Donor is able to vote on the funding request for the charity project already participated.
5. After the request for funds is approved, the funds are automatically transferred to the beneficiary's account.

📃 Description

• We have created a Solidity Smart Contract for this cause and we have used web3, ganache-cli, mocha, to test out our contract.

• In the contracts folder, you will find a final solidity contract and the individual modules inside contracts_classified directory.

• On the Frontend Part we have html,css,javascript and full UI of Genuine Charity App along with Admin Panel in the website folder.

• Included a test directory with a test file to test all the functions used in the contract by deploying it on ganache and using web3 to utilize the ABI.

• Included a sample React Template so that the frontend can be used to include the website along with the test code to make a production app.

• Included code to compile the contract and to deploy the contract on the Rinkeby Test Network using the Infuria node module.

• The website and the test modules are not yet connected and the code is placed in seperate folders.

• GitHub repo link: Link to repository

• Drive Link to Screenshots: Link to Drive

• Drive Link to Research Paper on Genuine Charity using Ethereum Contracts - Link to Drive

• EthFiddle Link to Test the Contract - Link to EthFiddle

🛠Technology stack

Tools and technologies that we learnt and used in the project.

1. Solidity
2. HTML,CSS,JS,React
3. Node JS
4. web3,ganache-cli,mocha,solc node modules

🚀 Instructions to run the application (DEVELOPMENT)

1. Clone the Repository

git clone https://github.com/Shreyas-Penkar/Genuine-Charity-Application.git

2. Create a Node app and install dependencies

npm init

after following the steps run

npm install web3@1.0.0-beta.26
npm install mocha@8.2.1
npm install solc@0.4.17
npm install truffle-hdwallet-provider
npm install ganache-cli@6.12.2

3. Refer to the package.json file for full details on the installed packages.

4. To run the Contract online, refer to the EthFiddle Link above.

5. To compile the contract use

node compile.js

6. To run the test module, in your package.json under the "scripts" object, add

"test": "mocha --timeout 15000"

then run

npm run test

Ganache Deployment Diagram

7. To deploy the contract on the Rinkeby Test Network using Infura, follow the steps -

• Register on Infura - https://infura.io/register

• Follow all the steps there for account activation

• After that you'll see a dashboard similar to this -

• Install the MetaMask Browser extension - Link to MetaMask Chrome Extension

• Make an account and note down the 12 word mnemonic generated.

• Now, Go to Infura and get the link to the Test Ethereum Network, it would look something like this -

• Now enter the 12 word mnemonic and the link in deploy.js over here -

• Now run this command on the terminal -

node deploy.js

Infura Deployment Diagram

📝Applications

Many fake charity organizations pose as genuine and loot money from innocent people in the name of charity. Most people want to donate money to a good cause of charity, but they are unsure if the money is going to reach the right hands of the destitute. The blockchain system can bring transparency to online charity trusts. Contributors can see the journey of the donation in realtime and confirm if it’s reaching the deserving hands or not.

👨‍🎓What did we learn from this project

1. Shreyas Penkar -
   It was awesome working as a leader in this project. I learnt how Blockchains work giving me a clear understanding of the various moving pieces and concepts regarding Blockchain. I was able to contribute to a solidity contract and write tests for the same. I gained many useful skills related to management, leadership, team-work and also got to know a lot about my co-workers and mentors. It was fun working with them on this project. So, overall it was a huge success.
2. Jainam Dharod -
   It was wonderful experience working on this project and exploring this wonderful new domain of Blockchain Technology.I learbt Smart Contracts, Solidity Programming language through this project. Apart from this, I also learnt a lot from my teammates and mentors who helped me every step throughout this project.Overall, this was a great experience for me.
3. Purva Anjarlekar -
   Working on this project was a delightful and educative experience. I have to say, I couldn't have asked for better teammates. We all got to learn blockchain and the meets we had corresponding to this subject, especially the one in the beginning with our super senior was simply awesome. Apart from the topics in blockchain, working with this team helped me improve my people skills. Overall, this was an amazing experience and I have the team and SkillUp project to thank for it!
4. Aishwarya Harkare -
   Collaborating with the team was indeed wonderful experience for me. Working on this project I could dive into the whole new world of Blockchain Technology.I learnt Smart Contract , Solidity programming language through this project. I got to write a bit of Smart Contract for this Application. Further, I coordinated with my collegue Purva Anjarlekar in making Frontend of the website. Working with Teammates and mentors helped me gain skills such as team-work , communication skills. Thus, this was a great adventure for me.
5. Rohan Sawai -
   It was an incredible experience for me. I got to learn the concept of Blockchain technology and various concepts related to Blockchain. As a member of this team, I contributed to the Solidity contract, a small part of frontend and also wrote tests. I learned skills like team-work, time-management and how to effectively communicate with my team. Furthermore, would like to thank our leader, Shreyas and mentors for guiding me right from basic learning resources. Overall it was an amazing experience!
6. Santanu Kumar -
   I had a great time working on this project.I was introduced to the blockchain technology.I got to learn vaious concepts regarding Blockchain, Solidity language etc. During the project I got to run a local blockchain system which helped me to clear my concepts.It was fun writing the smart contracts and testing them.Further ,close coordination and communication with my team members and mentors helped us complete this project and I would like to thank them all for guiding me and providing me with the resources.

🔮Future scope

• As the frontend is not yet connected to the contract, we could first connect it using a sample node server or by using React.
• Make the UI/UX even better.
• Make an Andriod app for this idea.

🎨Screenshots