snarfed / bridgy-fed

Bridgy Fed === Bridgy Fed connects different decentralized social network protocols. It currently supports the fediverse (eg Mastodon) via ActivityPub, Bluesky via the AT Protocol, and the IndieWeb via webmentions and microformats2. Farcaster and Nostr are under consideration. Bridgy Fed translates profiles, likes, reposts, mentions, follows, and more from any supported network to any other. See the user docs and developer docs for more details. https://fed.brid.gy/ License: This project is placed in the public domain. You may also use it under the CC0 License. Development --- Development reference docs are at bridgy-fed.readthedocs.io. Pull requests are welcome! Feel free to ping me in #indieweb-dev with any questions. First, fork and clone this repo. Then, install the Google Cloud SDK and run to install the Firestore emulator. Once you have them, set up your environment by running these commands in the repo root directory: Now, run the tests to check that everything is set up ok: Finally, run this in the repo root directory to start the web app locally: If you send a pull request, please include (or update) a test for the new functionality! If you hit an error during setup, check out the oauth-dropins Troubleshooting/FAQ section. You may need to change granary, oauth-dropins, mf2util, or other dependencies as well as as Bridgy Fed. To do that, clone their repo locally, then install them in "source" mode with e.g.: To deploy to the production instance on App Engine - if @snarfed has added you as an owner - run: How to add a new protocol --- • Determine how you'll map the new protocol to other existing Bridgy Fed protocols, specifically identity, protocol inference, events, and operations. Add those to the existing tables in the docs in a PR. This is an important step before you start writing code. • Add the new protocol to in . • Implement the id and handle conversions in . • If the new protocol uses a new data format - which is likely - add that format to granary in a new file with functions that convert to/from ActivityStreams 1 and tests. See and for examples. • Implement the protocol in a new file as a subclass of both and . Implement , , , , , and other necessary methods from , and , , , and other necessary methods from . • TODO: add a new usage section to the docs for the new protocol. • TODO: does the new protocol need any new UI or signup functionality? Unusual, but not impossible. Add that if necessary. • Protocol logos may be emoji and/or image files. If this one has a file, add it . Then add the emoji and/or file tag to the subclass's and/or constants. How to post as the protocol bot accounts: @ap.brid.gy, @bsky.brid.gy, etc --- The protocol bot accounts - @ap.brid.gy, @bsky.brid.gy, and so on - don't have user-facing UIs to log into and post as, but it's still possible to post as them! And repost etc. Here's how. They're currently set up as bridged _web_ accounts. To post to them, first create a blog post _without title_ on snarfed.org, _check that it's under 300 chars for Bluesky_, then send a webmention to Bridgy Fed to make it bridge the post. The source should be of the form eg , where URL is the snarfed.org post's URL, _without_ , eg . (Ideally we'd like to be able to do this from blog.anew.social too! They don't support microformats in the default theme, though, so we'd need to switch to a microformats-enabled theme first. 😕) Stats --- I occasionally generate stats and graphs of usage and growth via BigQuery, like I do with Bridgy. Here's how. • Export the full datastore to Google Cloud Storage. Include all entities except . Check to see if any new kinds have been added since the last time this command was run. Note that is required. From the export docs: > _Data exported without specifying an entity filter cannot be loaded into BigQuery._ • Wait for it to be done with . • Import it into BigQuery: • Check the jobs with , then wait for them with . • Run the full stats BigQuery query. Download the results as CSV. • Open the stats spreadsheet. Import the CSV, replacing the _data_ sheet. • Check out the graphs! Save full size images with OS or browser screenshots, thumbnails with the _Download Chart_ button.