algoskip

> extensible diy feed algos in a frame

> skip the algorithm

---

Table of Contents

1. Demo
2. Overview
3. Motivation
4. Workflows
5. Get Started
6. Contributors

Demo

Live on warpcast: https://warpcast.com/3070/0xe5770891

Developers: To learn how to run the app, please skip to Get Started

Interact with algoskip using Warpcast's frame validator tool with the below details:

• frame validator tool: https://warpcast.com/~/developers/frames
• algoskip deployment url (initial frame): https://algoskip.vercel.app/frame/home

1. Go to the frame validator tool using the link above
2. Copy and paste the deployment url above for the initial frame
3. Click the button to the right of where you pasted the URL
4. Interact with algoskip

Overview

algoskip is a Farcaster Frame implementation of a Farcaster feed. It serves Farcaster casts via filters and algorithms that the user selects, bypassing the hard-coded algorithm set by the client in which the user is viewing the frame, or injecting casts into any environment that supports Farcaster Frame embeds.

Motivation

One of the most valuable aspects of decentralized protocols, such as Farcaster, is the public accessibility of data. algoskip serves to highlight the notion of composability afforded by such protocols, through accessing public data and allowing users to "skip the algorithm" via the Farcaster Frame technology.

Workflows

1. Composing Criterias
2. Browsing Selected Casts

Composing Criterias

Users are able to compose criterias to retrieve desired casts.

This workflow involves:

1. Selecting the category of casts: "my casts" or "trending"
2. Applying filters and Selecting a sorting algorithm
3. If "trending" selected: Also Selecting a channel to filter by
4. Performing a "reveal" in which a selection of casts are retrieved by algoskip and served to the user

Browsing Selected Casts

Users can browse the "revealed" casts via Farcaster Frame buttons.

This workflow involves:

1. Navigating the selection of casts "revealed" by the criterias set by the user
2. Viewing a cast with context by pressing the "goto cast" button and navigating to a _Farcaster_client, such as Warpcast

Get Started

You must have your own Neynar api key to run this app. If you don't have one, please head over to https://neynar.com/ before following the below steps

1. Clone the repo through GitHub: https://github.com/eucalyptus-viminalis
2. Make a copy of .env.example file and name it .env.local
3. Set NEYNAR_API_KEY environment variable in .env.local
4. Run pnpm install or npm install at the command line to install the project's dependencies
5. Run pnpm dev or npm dev to run the app
6. Test frame routes located at /src/api/* using HTTP clients like Postman or deploy the app to a platform like Vercel and use the deployment URL to interact with the frame using Warpcast's frame validator tool (https://warpcast.com/~/developers/frames)

Contributors

• 3070 (Warpcast Profile)