1. Introduction
2. Technology Stack
3. Architecture
4. Run Locally
5. Usage Guide
6. Smart Contract Documentation
7. Deployment
8. Future Improvements
9. Contributing
10. Community

Fundr is a blockchain based platform for community-driven funding. Users can deploy funding vaults, deposit funds, and submit proposals for funding. The platform uses a voting mechanism to decide which proposals receive how much funding.

• Frontend: Next.js, TailwindCSS, ShadCN UI
• Backend: Next.js API Routes, Prisma ORM, NextAuth, SIWE, Web3Modal
• Blockchain: Foundry, Solidity
• Database: PostgreSQL
• Other tools and libraries: Wagmi, Viem, React Hook Form

1. Foundry Setup: Ensure you have Foundry installed and setup. You can follow the instructions given here: Foundry Docs.

2. Node.js: Ensure you have Node.js Installed. You can follow the instructions here: Nodejs Docs

1. Navigate to the Blockchain Directory:

   cd app/blockchain

2. Install Dependencies:

   forge install

3. Run Tests:

   forge test

4. Run Local Anvil Chain:

   anvil

5. Deploy Mock Smart Contracts:

   make mock-all

   Note: This will automatically update relevant contract addresses and ABIs for smart contract in web-app folder.

6. Deploy to the Testnet:

   • Ensure you have a .env file set up. You can use .env.example as a template.
   • Load the environment variables:

   source .env

   • Deploy the contract:

   deploy-sepolia

1. Navigate to the Web App Directory:

   cd app/web-app

2. Install Dependencies:

   npm install

3. Update the environment variables: Create a .env file in the web-app directory and add all the values. You can use .env.example as a template.

4. To use local instance of postgreSQL database:

   1. Start docker desktop
   2. Run docker compose up

5. Run the Development Server:

   npm run dev

6. Access the Web App:

   • Open your browser and navigate to http://localhost:3000.

Our platform supports three types of users: Vault Creators, Proposal Creators, and Voters/Community Members. Here's how each user type can navigate and use the application:

1. Getting Started

   • On the landing page, click "Get Started" to access the dashboard
   • Connect your wallet and sign in with Ethereum

2. Creating a Vault

   • Click the "Create" button and select "Vault" from the dropdown
   • Choose a space for your vault (multiple vaults can exist in one space)
   • Enter the vault description, token configurations, and funding parameters
   • Review and submit the proposal (requires a wallet transaction)

3. Optional: Add Funds

   • After creation, you can immediately add funds to your vault

4. Vault Management

   • You'll be redirected to the vault page to view all details

1. Getting Started

   • On the landing page, click "Get Started" to access the dashboard
   • Connect your wallet and sign in with Ethereum

2. Creating a Proposal

   • Click the "Create" button and select "Proposal" from the dropdown
   • Search and select the vault you want to create a proposal for
   • Enter the proposal description, minimum and maximum request amounts, and recipient address
   • Review the information and submit

3. Tracking Proposals

   • View your created proposals in the "My Activity" page or on the vault details page

1. Accessing Vaults

   • On the landing page, click "Get Started" to access the dashboard
   • Click "Spaces" in the navbar to view available spaces
   • Select a space and then choose a vault within that space

2. Participating in a Vault

   • On the vault page, register to vote
   • Deposit tokens for distribution
   • Create new proposals (if desired)
   • After the tally date, withdraw remaining funds (if applicable)

3. Viewing Results

   • After the tally date, results page will be accessible to view the distribution statistics and other vault-related information

Smart contract documentation can be found here.

• Smart Contract: [Sepolia Testnet](https://sepolia.etherscan.io/address/0x01688B3c89cDCb6fa64378DF2aD8Eb37DDFf9721
• Frontend: https://fundr-nu.vercel.app/