search

lucahammer / fedifinder

Find fediverse addresses in the profiles of your Twitter followings
https://fedifinder.glitch.me/
MIT License
248 stars 27 forks source link

readme

Find fediverse accounts of your Twitter contacts

Use it at fedifinder.glitch.me or run it on your own server.

Contributing and running your own fedifinder

The easiest way to run your own version of fedifinder is to use the remix option of Glitch:

  1. Go to the project page https://glitch.com/edit/#!/fedifinder
  2. Click the Remix button on the top right: Remix
  3. This will spin up your own server. You don't need an account, but then it will be deleted after 5 days. Enough time to play with it.
    1. Optional: Change the URL in the settings at the top left "Edit Project Details". If the name contains "dev" or "staging" fedifinder will automatically run tests that can tell you if some functions correctly work. Useful for development. Annoying if you just want to use it.
  4. Sign up for a Twitter Developer account and create an API v2 app: developer.twitter.com/.
    1. Choose "User authentication set up"
    2. App permissions "Read"
    3. Type of App: Web, App or Bot
    4. Important: Set the Callback URI to https://YOUR_PROJECT_NAME.glitch.me/login/twitter/return
    5. Copy API Key and API Secret for the next step
  5. Back in your Glitch project, go to the file .env and fill out the four variables.
    • TWITTER_CLIENT_ID (from the Twitter Developer Portal)
    • TWITTER_CLIENT_SECRET (from the Twitter Developer Portal)
    • DB_CLEAR (Can be any string, but must start with / because it is used as an URL path for certain functionality)
    • SECRET (Any string. Is only used for the sessions.) .env file
  6. The server should automatically start the app. And restart it whenever you change something in the server.js. Status, Logs, and Terminal are at the bottom.
  7. Optional: You can send code to Github (commit) by clicking Tools at the bottom of the screen, then export.
  8. Optional: If there are new things in the main version (branch), you can use the same menu, select Import from Github and enter lucahammer/fedifinder. This will overwrite your own changes, but you will be able to get them back by using the Rewind option the same menu.
  9. Optional: If you improved fedifinder, please submit a pull request on Github, so the changes can be added to the main branch. If you need inspiration, on what do work on, look into the Github Issues

You should be able to run it anywhere where you got node.js, but I haven't tested it. You will need PROJECT_DOMAIN and PORT as .env variables in addition of the four from step 5.

Take a look at the Code of Conduct and get in contact with @luca@vis.social if something or someone makes you uncomfortable.

Background

Fedifinder is based on opml.glitch.me. A tiny tool which I built in 2008. It enables people to export the RSS feeds of the websites of the accounts they follow on Twitter as an OPML file to import it into a RSS reader. Twitter was my special interest and I am devastated by Musk's decisions. I adapted Fedifinder on a weekend and have since tried to keep up with issues and requests.

Consent is probably the only principle of fedifinder. It should only find, what people have made public themselves.

Thanks

This project wouldn't be possible without the awesome Open Source Community.

Hosting

Frontend

Backend