https://github.com/aytaditya/web3-goalkeeper

GoalKeeper is a blockchain-powered task management application that incentivizes productivity. Users can deposit funds and assign tasks, and upon completing all tasks, they retrieve their deposited funds.
https://github.com/aytaditya/web3-goalkeeper

blockchain dapp frontend hardhat javascript nextjs smart-contracts solidity tailwindcss thirdweb typescript

Last synced: about 2 months ago
JSON representation

GoalKeeper is a blockchain-powered task management application that incentivizes productivity. Users can deposit funds and assign tasks, and upon completing all tasks, they retrieve their deposited funds.

• Host: GitHub
• URL: https://github.com/aytaditya/web3-goalkeeper
• Owner: Aytaditya
• Created: 2024-12-29T15:13:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-30T08:15:24.000Z (over 1 year ago)
• Last Synced: 2026-01-03T17:14:48.337Z (5 months ago)
• Topics: blockchain, dapp, frontend, hardhat, javascript, nextjs, smart-contracts, solidity, tailwindcss, thirdweb, typescript
• Language: TypeScript
• Homepage:
• Size: 2.12 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

# GoalKeeper  



  

  

  

  

  

  



GoalKeeper is a blockchain-powered task management application that incentivizes productivity. Users can deposit funds and assign tasks, and upon completing all tasks, they retrieve their deposited funds.

![Landing page](./readme_images/Landing.png)

## Features  

- **Task Management**: Add, update, and track tasks.  

- **Blockchain Integration**: Secure fund deposits and withdrawals using smart contracts.  

- **Incentivized Workflow**: Complete tasks to unlock deposited funds.  

---

![Adding funds](./readme_images/fundsAddition.png)

## Tech Stack  

- **Frontend**: [Next.js](https://nextjs.org/), TypeScript, [Tailwind CSS](https://tailwindcss.com/)

- **Blockchain Frameworks**: [ThirdWeb](https://thirdweb.com/), [Hardhat](https://hardhat.org/)  

- **Smart Contracts**: Solidity  

![No Task Added](./readme_images/Tasks.png)

---

![Adding funds](./readme_images/AddingTask.png)

![Adding funds](./readme_images/AddingTask1.png)

![Adding funds](./readme_images/AddingTask2.png)

## Prerequisites  

- Node.js (>= 16.x)  

- Yarn or npm  

- MetaMask or compatible wallet  

- ThirdWeb account  

---

## Getting Started  

### 1. Clone the Repository  

```bash  

git clone https://github.com/Aytaditya/Web3-GoalKeeper

cd Web3-GoalKeeper

```  

### 2. Install Dependencies  

```bash  

yarn install  

# or  

npm install  

```  

### 3. Set Up Environment Variables  

Create a `.env.local` file in the root directory and add the following variables:  

```env  

NEXT_PUBLIC_THIRDWEB_PROJECT_ID=your_thirdweb_project_id  

```  

### 4. Run the Development Server  

```bash  

yarn dev  

# or  

npm run dev  

```  

The application will be accessible at `http://localhost:3000`.  

### 5. Deploy Smart Contracts  

1. Navigate to the `contracts/` directory.  

2. Deploy the contracts using Hardhat:  

   ```bash  

   npx thirdweb deploy -k SECRET_KEY

   ```  

![Tasks](./readme_images/Tasks.png)

### 6. Configure ThirdWeb  

Add your deployed contract address to the ThirdWeb dashboard and update the configuration in the app.  

---

## Usage  

1. **Connect Wallet**: Log in with your wallet using MetaMask.  

2. **Add Tasks**: Enter tasks with descriptions.  

3. **Deposit Funds**: Add funds that will be held in the smart contract until tasks are completed.  

4. **Complete Tasks**: Mark tasks as completed to withdraw funds.  

---

![Completing Task](./readme_images/CompletingTask.png)

## Folder Structure  

 ``` 

GoalKeeper/  

├── goalkeeper/            # Blockchain-related files  

│   ├── contracts/         # Smart contracts (Hardhat)  

│   │   └── Contract.sol   # Main Solidity contract  

│   └── scripts/           # Deployment scripts  

└── client/                # Next.js client application  

    ├── public/            # Static assets  

    ├── src/  

    │   ├── components/    # Reusable components  

    │   ├── pages/         # Application routes  

    │   ├── styles/        # Global styles (includes Tailwind configuration)  

    │   ├── utils/         # Utility functions  

    │   └── hooks/         # Custom React hooks  

 ``` 

---

## Smart Contract Overview  

- **Contract.sol**  

  - Handles task creation, fund deposits, and withdrawals.  

  - Interacts with ThirdWeb for seamless integration.  

---

![Wallet Integration](./readme_images/WalletIntegration.png)

## Deployment  

- Frontend: Deploy the application on [Vercel](https://vercel.com/).  

- Smart Contracts: Deploy on supported blockchain networks (e.g., Polygon, Ethereum).  

---

## Contributing  

Contributions are welcome! Feel free to open issues or submit pull requests.  

---

## Contact  

- **Author**: Aditya Aryan  

- **Email**: adityaaryan531@example.com  

- **GitHub**: [Aytaditya](https://github.com/Aytaditya)  

```