🏗 Contribu

Documentation | Website

🧪 An open-source, up-to-date community platform leveraging the Ethereum Attestation Service (EAS) to verify and reward contributions. Designed to make it easier for communities to recognize member contributions using dynamic NFTs that evolve based on points accumulated from attestations.

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript.

✅ Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
🪝 Custom hooks: Collection of React hooks wrapper around wagmi to simplify interactions with smart contracts with typescript autocompletion.
🧱 Components: Collection of common web3 components to quickly build your frontend.
🔥 Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum network.

Requirements

Before you begin, you need to install the following tools:

Quickstart

To get started with Contribu, follow the steps below:

Clone this repo & install dependencies

git clone https://github.com/ContribuDev/Contribu.git
cd contribu
yarn install

Run a local network in the first terminal:
```
yarn chain
```
This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in hardhat.config.ts.
On a second terminal, deploy the test contract:
```
yarn deploy
```
This command deploys a test smart contract to the local network. The contract is located in packages/hardhat/contracts and can be modified to suit your needs. The yarn deploy command uses the deploy script located in packages/hardhat/deploy to deploy the contract to the network. You can also customize the deploy script.
On a third terminal, start your NextJS app:
```
yarn start
```
Visit your app on: http://localhost:3000. You can interact with your smart contract using the Debug Contracts page. You can tweak the app config in packages/nextjs/scaffold.config.ts.

What's next:

Edit your smart contract YourContract.sol in packages/hardhat/contracts
Edit your frontend homepage at packages/nextjs/app/page.tsx. For guidance on routing and configuring pages/layouts checkout the Next.js documentation.
Edit your deployment scripts in packages/hardhat/deploy
Edit your smart contract test in: packages/hardhat/test. To run test use yarn hardhat:test

Documentation

Visit our docs to learn how to start building with Contribu.

To know more about its features, check out our website.

Contributing to Contribu

We welcome contributions to Contribu!