Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vjousse/fedirelm
Multi server fediverse library and client (mastodon, pleroma, …)
https://github.com/vjousse/fedirelm
elm elm-lang fediverse gotosocial mastodon pleroma
Last synced: 2 months ago
JSON representation
Multi server fediverse library and client (mastodon, pleroma, …)
- Host: GitHub
- URL: https://github.com/vjousse/fedirelm
- Owner: vjousse
- License: agpl-3.0
- Created: 2024-06-24T21:29:19.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-18T16:54:53.000Z (5 months ago)
- Last Synced: 2024-10-01T09:21:33.064Z (3 months ago)
- Topics: elm, elm-lang, fediverse, gotosocial, mastodon, pleroma
- Language: Elm
- Homepage:
- Size: 167 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fedirelm: a multi backend Fediverse client (Mastodon, Pleroma, GoToSocial,…)
> [!WARNING]
> This is still a Work In Progress
## ❔ Why?
I love the diversity of the Fediverse, I hate having to use multiple clients to be able to connect to my servers.
The main goal of this code is to provide a client and a library that can connect to multiple Fediverse backends while providing an unified UX to do so.
## 🔨 How?
The code is splitted in two parts:
- `Fediverse` is the library abstracting the connection to the backends
- `Fedirelm` is the web client using the `Fediverse` library to provide an usable UI
You can install and run the project using npm :
npm install
npm run dev
## 💯 Inspiration
I'm reading [megalodon-rs](https://github.com/h3poteto/megalodon-rs) source code a lot to check how they are doing the backend abstraction.
## 📚 FAQ
### Can I use it?
No, not really for now. You can contribute by mapping some backends if you want to, but it's not usable in production for now.
### What are the supported backend?
For now I plan to support:
- Mastodon
- Pleroma
- GoToSocial
Mostly because I have accounts on some servers. _Firefish_ and _Friendica_ support may come in the future.
### Will it support backend X
Who knows? The goal of the library is to abstract the backends, so any new backend could be supported in the future.
### Why Elm?
[Elm](https://elm-lang.org/) is still, by far, the best language to make reliable frontend web apps. The [community](https://elm-lang.org/community) is thriving, the language is very stable and I know I will be able to maintain this code ten years from now thanks to Elm type system.
### Will it be available as a Desktop or Mobile app?
It's part of the plan, at some point using [Tauri](https://tauri.app/) as I did for [Pomodorolm](https://github.com/vjousse/pomodorolm).
## 🆓 License
[AGPL-3.0-or-later](https://www.gnu.org/licenses/agpl-3.0.html)
