https://github.com/LiveFastEatTrashRaccoon/RaccoonForLemmy
A Kotlin Multiplatform client for Lemmy
https://github.com/LiveFastEatTrashRaccoon/RaccoonForLemmy
android-app compose-multiplatform fediverse-client kotlin kotlin-multiplatform lemmy-client lemmy-moderation
Last synced: 10 days ago
JSON representation
A Kotlin Multiplatform client for Lemmy
- Host: GitHub
- URL: https://github.com/LiveFastEatTrashRaccoon/RaccoonForLemmy
- Owner: LiveFastEatTrashRaccoon
- License: gpl-3.0
- Created: 2024-06-21T00:29:47.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-11-08T22:05:29.000Z (6 months ago)
- Last Synced: 2024-11-08T22:19:18.028Z (6 months ago)
- Topics: android-app, compose-multiplatform, fediverse-client, kotlin, kotlin-multiplatform, lemmy-client, lemmy-moderation
- Language: Kotlin
- Homepage: https://livefasteattrashraccoon.github.io/RaccoonForLemmy
- Size: 48.2 MB
- Stars: 20
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-lemmy - RaccoonForLemmy - activity/y/LiveFastEatTrashRaccoon/RaccoonForLemmy) | Android (Projects / Mobile / Desktop apps)
README
# Raccoon for Lemmy
Raccoon for Lemmy is a client for the federated aggregation and discussion platform Lemmy.
The project is powered by Kotlin Multiplatform (KMP) and Compose Multiplatform (CMP).
It started in 2023 as an exercise to play around with Kotlin and Compose multiplatform and gradually
grew as a fully functional client.
Main features:
- view post feed and comments with different listing and sort types;
- possibility to upvote and downvote (with configurable swipe actions);
- community and user detail (with custom sort types);
- review your own posts and comments (created by you, bookmarked, liked/disliked);
- inbox with replies, mentions and direct messages;
- global search on Lemmy with different result types (all, posts, comments, user, communities);
- create and edit new posts (with optional images);
- cross-post contents to other communities;
- reply to post and comments (and edit replies);
- mark posts as read and hide read contents;
- custom appearance (color scheme, fonts, text sizes, post layout, etc.);
- custom localization (independent of system settings);
- block users, communities and instances;
- report post and comments to moderators;
- support for multiple accounts (and multiple instances) with account-specific settings;
- lazy scrolling (referred to as "zombie mode");
- explore all the communities on a given instance in guest mode;
- multi-community (community aggregation);
- community moderation, instance moderation and moderation log;
- save posts and comments you are creating as drafts to edit them later;
- add custom tags to users to easily recognize them across communities.
## Want to try it out?
Here are some options to install the application on your device, apart from downloading the APKs
from the [Releases](https://github.com/LiveFastEatTrashRaccoon/RaccoonForLemmy/releases) page.
> [!TIP]
> On Obtainium, please make sure to check the "Include pre-releases" option: by doing so you will be
> able to receive all alpha and beta builds automatically.
## Want to leave your feedback or report a bug?
Reach out to the community on Lemmy, Matrix or file a report in the [issue tracker](https://github.com/LiveFastEatTrashRaccoon/RaccoonForLemmy/issues)
here on GitHub. Alternatively, you can always write an [email](mailto://[email protected]).
Please remember: every contribution is welcome and everyone's opinion matters here. This is a community project,
open source, ad-free and free of charge, and it belongs to us all so don't be afraid to get involved.
And don't forget every 🦝's motto: `#livefasteattrash`.
## Would you like to improve the existing translation?
Translators and localizators, your work is of paramount importance to make sure user experience is
of high quality on the app! If you want to help with the localization, please have a look at the
project on Weblate and submit your changes.
## Screenshots
## Why was the project started?
Because raccoons are so adorable, aren't they? 🦝🦝🦝
Joking apart, one of the main goals was to experiment with KMP and learn how to properly deal with
the challenges of a multiplatform environment, and a medium-sized project like this was an ideal
testing ground for that technology.
Secondly, I felt that the Android ecosystem of Lemmy apps in 2023 was a little "poor" with few native
apps (fewer open source), while the "market" is dominated by iOS and cross-platform clients.
I️ ❤️ Kotlin, I ❤️ Free and Open Source Software and I ❤️ native app development, so there was a niche
that could be filled.
Developing a new client was an opportunity to add all the good features that were "scattered" across
different apps, e.g. the feature richness of [Liftoff](https://github.com/liftoff-app/liftoff),
the multi-community feature of [Summit](https://github.com/idunnololz/summit-for-lemmy) and the
polished UI of the really great [Thunder](https://github.com/thunder-app/thunder) and so on.
This app tries to be configurable enough to make users feel "at home" and choose what they want,
while at the same time having a not too cluttered interface.
In the third place, this app has been a means to dig deeper inside Lemmy's internals and become more
humble and patient towards other apps because there are technical difficulties in having to deal
with a platform like Lemmy.
This project _is_ all about experimenting and learning, so please be patient.
The app is intended both to regular users and moderators. To the formers, it offers the ability to
change a lot of aspects like font face or size and app colors, post layout, vote format, and so
on in order to create a tailor-made solution for their needs and personal tastes.
For moderators and admins who want to use their mobile device, the app provides a set of moderation
tools (feature post, lock post, distinguish comment, remove post/comment, ban users) and the ability
to revert any of these actions. It also has admin tools (purge users/posts/comments/communities,
feature posts locally, hide/unhide communities) to simplify admin moderation without having to
switch to the web UI.
## Technical notes:
- [Calf](https://github.com/MohamedRejeb/Calf) for a web view implementation;
- [Coil](https://github.com/coil-kt/coil) for image loading;
- [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform) for UI;
- [Compose ColorPicker](https://github.com/skydoves/colorpicker-compose) for custom color selection;
- [Compose Multiplatform Media Player](https://github.com/Chaintech-Network/ComposeMultiplatformMediaPlayer)
for video playback;
- [Kodein](https://github.com/kosi-libs/Kodein) for dependency injection;
- [Ktor](https://ktor.io/) and [Ktorfit](https://foso.github.io/Ktorfit) for networking;
- [Multiplatform Markdown Renderer](https://github.com/mikepenz/multiplatform-markdown-renderer) for
Markdown rendering
- [Multiplatform Settings](https://github.com/russhwolf/multiplatform-settings) for encrypted shared
preferences;
- [MaterialKolor](https://github.com/jordond/MaterialKolor) for custom theme generation;
- [SQLDelight](https://github.com/cashapp/sqldelight)
and [SQLCipher](https://github.com/sqlcipher/sqlcipher) for local persistence
- [Voyager](https://voyager.adriel.cafe/) for navigation;
More info about the technologies used in the project can be found in
the [CONTRIBUTING.md](https://github.com/livefasteattrashraccoon/RaccoonForLemmy/blob/master/CONTRIBUTING.md#51-tech-stack).
## Disclaimers
> [!WARNING]
> This is an experimental project and some technologies it is build upon are still in pre-production
> stage, moreover this is a side-project developed by volunteers in their spare time, so use
> _at your own risk_.
This means you should be prepared to occasional failures, yet-to-implement features and areas
where some polish is needed.
> [!WARNING]
> Starting from version 1.13.0-beta01 (118) the application ID has changed so if you are running
> Raccoon 1.13.0-20240730-pre or earlier version you are not receiving updates any more and you are
> encouraged to upgrade. You can save a backup of your settings using the "Export settings
> to file" option in the "Advanced Setting" screen and reimporting the JSON using "Import settings
> from file" in the new app.
The app is maintained by the same people and in the same spirit, it was just a package name change
and the repository ownership was moved to an organization.