https://github.com/thecoderadi/causefundr
https://github.com/thecoderadi/causefundr
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thecoderadi/causefundr
- Owner: TheCoderAdi
- Created: 2024-10-20T13:19:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-04T17:48:16.000Z (over 1 year ago)
- Last Synced: 2025-06-10T08:41:29.734Z (11 months ago)
- Language: JavaScript
- Size: 3.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CauseFundr
## Milestone
This project won the "Best Build on Linea"🏆
[Link](https://www.hackquest.io/en/hackathon/projects/HackOdisha-40-CauseFundr)
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Introduction
CauseFundr is a social crowdfunding platform based on blockchain that empowers individuals and organizations to raise funds for various causes. Whether you're supporting a community initiative, medical expenses, or educational projects, CauseFundr connects generous donors with meaningful causes.
## Features
- **Campaign Creation**: Easy setup for fundraising campaigns with detailed descriptions and goals.
- **Donation Management**: Track donations and contributions seamlessly.
- **Real-Time Updates**: Donors receive updates on the progress of the campaigns they support.
- **Responsive Design**: Optimized for both desktop and mobile devices.
## Technologies Used
- **Frontend**: React, Tailwind CSS
- **Smart Contracts**: Solidity and HardHat
## Must Have
- Node Js Installed
- Browser with metamask
## Installation
To get a local copy of CauseFundr up and running, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/TheCoderAdi/causefundr.git
```
2. Navigate to the project directory:
```bash
cd causefundr
```
3. Install the dependencies:
```bash
bun install
```
4. Start the development server:
```bash
bun start
```
5. To get accounts from hardhat:
```bash
npx hardhat node
```
6. Deploy the contract on testnet:
```bash
npx hardhat run .\scripts\deploy.cjs --network localhost
```
## Usage
1. Visit `http://localhost:5173` in your browser to access the application.
2. Connect your wallet to start creating or donating to campaigns.
3. Explore various campaigns and contribute to causes you care about.
## Contributing
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeature
```
3. Make your changes and commit them:
```bash
git commit -m "Add your message here"
```
4. Push to the branch:
```bash
git push origin feature/YourFeature
```
5. Create a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
Aditya Swayamsiddha
[LinkedIn](https://www.linkedin.com/in/aditya-swayamsiddha-576ab426a/)
Feel free to reach out for questions, suggestions, or collaboration opportunities!