Skip to content

pubkeyapp/pubkey-opencast

 
 

Repository files navigation

Notice: 6 Feb 2024

Unfortunately I started having issues with my hub replicator after the unprecedented growth since the launch of Frames due to hardware constraints. Working on syncing the new replicator but still having trouble and haven't had the time to fix unfortunately so my instance opencast.stephancill.co.za is down for now.

You are obviously free to (and I encourage you to) run it locally. Opencast supports the legacy replicator (check out the hub-monorepo around November last year) and the new replicator (hub-monorepo/apps/replicator) so you can use either. Running the replicator is quite challenging - please share your findings if you manage to successfully sync.

Opencast

A fully open source Twitter flavoured Farcaster client. Originally a fork of ccrsxx/twitter-clone.

The goal of this project is to provide a reference implementation of a Farcaster client in order to make it easier for developers to explore their ideas without having to start from scratch.

It only depends on the reference Farcaster postgres indexer and optionally a hub for submitting messages.

Development 💻

Farcaster Replicator

This project depends on the reference Farcaster PosgreSQL indexer. Follow the instructions at replicate-data-postgres to set up an instance.

Local

  1. yarn

  2. Copy the .env.sample file to .env and fill in the database connection details.

  3. yarn dev

Todo

  • Feed
    • Reverse chronological feed
    • Pagination
    • Number of likes, comments, and reposts
    • Recasts
  • Cast detail
    • Number of likes, comments, and reposts
    • Paginated replies
  • User profiles
    • Casts
    • Casts with replies
    • Media
    • Likes
    • Edit profile
  • Auth
  • Engagement actions
  • Post creation
    • Text only
    • Media
    • Mentions
    • Embeds
    • Topic
  • Post deletion
  • Search
    • User
    • Topic
    • Posts
  • Channels (now called Topics)
    • Channel detail
    • Channel discovery
    • Index channels
  • Fix mobile layout
  • Rebrand
    • Renaming (casts -> tweets, etc)
    • Images
    • Code
  • Notifications
    • Badge counter
    • Notifications page
  • Optimize
    • DB queries
    • Bandwidth

...

Tech 🛠

About

A fully open source Twitter flavoured Farcaster client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.2%
  • Other 1.8%