VoiceDeck

VoiceDeck is a platform that allows users to contribute retroactive funding for impactful grassroots journalism in India. Donors receive fractional shares of a HyperCert representing the impact of the reporting they've supported.

Features

Within the VoiceDeck app, users can

Search reports by category, state, progress
Examine report details, impact assessment, funding status
Anonymously prove Indian citizenship
Contribute funds with embedded crypto wallet
Track contribution activity and metrics

Run Locally

Clone the repository

  git clone [email protected]:VoiceDeck/app.git

Install dependencies

  cd app && pnpm install

Start the server

  pnpm dev

Tech Stack

Remix + Vite
Million.js
TailwindCSS
shadcn/ui components
Victory charts
Biome formatter/linter

We recommend direnv for managing your environment variables

Server Design

Endpoint Details

/impact-reports

Returns: An array of Report objects.
Purpose: To provide impact reports to the UI.
Implementation Details: Uses fetchReports() from server/impactReportHelpers.ts.

Server Functions

Located in app/server/impactReportHelpers.ts:

fetchReports: Function to retrieve reports, including interaction with Hypercerts.

Data Models

Impact Report: The report or stories that have been published previously and verified to actually produce an impact.
Hypercert: A token representing a claim of impactful work, which is fractionable and transferable, conforming to the ERC-1155 standard for semi-fungible tokens.
Hypercert Metadata: A set of data associated with a Hypercert, detailing the scope of work, contributors, impact, and rights, stored on IPFS.

Separation of Concerns

The /impact-reports endpoint is responsible for serving impact reports. The implementation details of how the server retrieves data from Hypercert are abstracted away and managed within the app/server/impactReportHelpers.ts file.

Getting Started

Prerequisites

Node.js: Before anything else, Remix.run requires that you have either a Active or Maintenance version of Node.js installed. Remix Documentation

Optimism Sepolia: Intuition is currently deployed on Optimism Sepolia Testnet. To interact with the Intuition API, you'll need to connect to the Optimism Sepolia Testnet.

Network Configuration

Parameter	Value
Network Name	`OP Sepolia`
RPC URL	`https://sepolia.optimism.io`
Chain ID	`11155420`
Currency Symbol	`ETH`
Block Explorer URL (Optional)	`https://sepolia-optimistic.etherscan.io`

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app+/_index.tsx. The page auto-updates as you edit the file.

Shadcn

Shadcn provides beautifully designed components that you can copy and paste into your apps and enables you to bootstrap them via cli (Shadcn Documentation). It 5x's your productivity and allows you to focus on what matters most, your business logic + features. Even better, we have set up the config for you so you can use it out of the box 🤝.

Example Usage:

npx shadcn-ui@latest add form

hodlerfolyf / app Goto Github PK

app's Introduction