Skip to content

ss251/farhack-frames-app

Repository files navigation

Stat Frame

Stat Frame is a Farcaster Frame server that allows users to explore detailed statistics within Farcaster frames by entering a Farcaster id or username. It provides user information, cast stats (past 30 days), and Moxie earnings stats (lifetime).

Check out the frame in action on Warpcast!

Placeholder GIF

Features

  • User Info: View profile information including display name, username, follower count, following count, and top channel contribution.

  • Cast Stats: Analyze casts over the last 30 days, including total casts, reactions, recasts, replies, engagement rate, and total contribution.

  • Moxie Stats: Check lifetime earnings stats for users, including total earned, cast earnings, frame developer earnings, and other earnings.

  • Note: Engagement Rate is calculated as the total number of reactions, recasts, replies, and views divided by the number of followers times 100.

Technologies Used

The project is built using the following technologies:

  • Next.js for building the web app.
  • Frog Framework for building Farcaster frames and local frame validation.
  • Frog UI for consistent and responsive UI components.
  • Neynar for Farcaster Hub.
  • Lum0x SDK for getting user information (followes, following, casts, reactions, recasts, replies, moxie earnings).
  • Nanograph API for getting top channel contribution and channel engagement metrics by user.
  • Vercel for hosting the application.

Installation

  1. Install dependencies:

    yarn install
  2. Create a .env file:

    In the root directory, create a .env file with the following content:

    LUM0X_API_KEY=your_lum0x_api_key
    NEYNAR_API_KEY=your_neynar_api_key

Running the Application

To start the development server:

yarn run dev

Devtools

To run the devtools:

yarn run copy:static
yarn run dev

Go to http://localhost:3000/api/dev to access the Frog devtools

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published