Skip to content

Latest commit

 

History

History
82 lines (50 loc) · 3.01 KB

README.md

File metadata and controls

82 lines (50 loc) · 3.01 KB
Raw

fcrn

Farcaster React Native (or fcrn) takes inspiration from Opencast for web, and aims to provide a reference implementation for developers to create mobile apps for farcaster without starting from scratch.

Support development by voting for this project via Prop House PurpleDao retroactive funding: https://prop.house/proposal/8614

Features Roadmap

  • Register Signer via Warpcast API
  • Persist Signer in encrypted storage
  • Write to Hub Actions
    • Signer flow working for Hub writes
    • Like Button
    • Create Cast
    • Recast
  • Reading Data via Neynar API
    • User Profiles
    • Feed API
  • Reading Data via Replicator
  • Profile Customization
  • Feed Support
    • Initial UI, API support

Build Example App

See Expo docs for machine setup (Node.js, Git, Watchman, etc.): https://docs.expo.dev/get-started/installation/

  1. cp EXAMPLE.env .env and fill in the mising values:
NEYNAR_API_KEY=<SEE https://neynar.com/>
HUB_URL=<http://<YOUR_SERVER_IP:2281>>
APP_FID=<FID_ASSOCIATED_WITH_OUR_APP>
APP_MNEMONIC=<MNEUMONIC_PRIVATE_KEY_FOR_APP_FID_CUSTODY_ADDRESS>
  1. From root directory yarn install to install repo dependencies
  2. run yarn dev to start expo
  3. Follow terminal instructions for testing the app on your iPhone or Android via the Expo Go mobile app.

The fcrn-example-app currently supports the following functionality:

  1. Register Signer via Warpcast Deeplink
  2. Persist Signer in encrypted Storage
  3. Fetch Feed and User Data via Neynar APIs
  4. Like posts via a Hub API using your registered, persisted signer
Click Connect Pay in Warpcast Poll for success Signer stored
Feed View User View

Integrate into an existing app

The following npm packages are available to install via your chosen package manager:

Click to see package README.md's and usage instructions.

Feedback

Feel free to open an issue at https://github.com/cameronvoell/fcrn or reach out to me on Farcaster @cyrcus

License

MIT License