Giter Club home page Giter Club logo

farcasterkit's Introduction

farcaster kit

farcaster kit og:image

react hooks for the best farcaster apps -- view docs

farcaster kit is made up of two parts:

  1. react hooks and modules to build the best farcaster apps
  2. a rest api to fetch data with or without the hooks

what's in the box?

  • ✅ rest api
  • ✅ read features
  • ✅ channels module
  • ✅ app-first feeds
  • ✅ historic data
  • ✅ user pages
  • 🔜 auth hooks
  • 🔜 write actions
  • 🔜 multi package/provider support

how this repo is structured

  • packages/farcasterkit - react hooks and modules, which are available to install with npm install farcasterkit
  • packages/create-farcaster-app - a CLI tool to scaffold an app using npx create-farcaster-app, which lives at examples/starter
  • apps/api - the rest api for farcaster kit
  • apps/web - the homepage and docs for farcaster kit, which you can view here
  • apps/old-replicator -- the postgres replicator powering farcaster kit, built by farcaster. a migration to the new replicator will happen soon!
  • examples/starter - a starter app which you can scaffold by using npx create-farcaster-app

built by dylsteck and powered by nexus


farcasterkit's People

Contributors

dylsteck avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

farcasterkit's Issues

feat: Add NeynarProvider

Description

Add a provider that supports auth and read/write capabilities using Neynar's @neynar/nodejs-sdk package and REST API.

Progress

  • Currently working in Litecast(testing changes in an app before moving to the farcasterkit package)
    • Connect to Warpcast
    • Read feeds, threads, and user profile info
    • Post casts/reactions
  • Up next
    • Extend hooks to provide all data necessary for Litecast(essentially feature parity with Neynar's APIs)
    • Test & move from Litecast directly to the farcasterkit package

For reference, here's the NeynarProvider file in Litecast

feat: Add signup and sign-in with EOA

Description

Add components & hooks for signup and sign-in with an EOA. This will be compatible with(and come with examples for) Dynamic, Privy, and RainbowKit out of the box, with future support for embedded wallets to further improve the signup/sign-in UX.

Progress

  • Signups are about ~90% done, you can see and read more about this integration's progress here
    • Need to fix an error I'm getting when calling the Bundler contract, then I can patch up styling and add the components/hooks to the farcasterkit package

feat: Standardize and upgrade API routes

Description

From my perspective, there are two main things that need to be fixed with the API:

  • Standardize pathnames for routes built directly on the replicator(paths that expose tables from the replicator's DB directly)
  • Upgrade API routes/schema to be more app ready, such as:
    • Including reactions in the cast object
    • Adding write functionalities

Changes to the API should not only offer routes to expose standard schema from the replicator, but also offer routes that are more app-ready, akin to the past Warpcast APIs.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.