fluffychat/README.md
2020-09-09 14:17:06 +02:00

3.8 KiB
Raw Blame History


Open FluffyChat in the browser - Join the community - Follow me on Mastodon - Translate FluffyChat - Translate the website - FAQ - Website



Features

  • Single and group chats
  • Send images and files
  • Offline chat history
  • Push Notifications
  • Account settings
  • Display user avatars
  • Themes, chat wallpapers and dark mode
  • Device management
  • Edit chat settings and permissions
  • Kick, ban and unban users
  • Display and edit chat topics
  • Change chat & user avatars
  • Archived chats
  • Discover public chats on the users homeserver
  • Registration

How to build

  1. Install flutter

  2. Clone the repo:

git clone --recurse-submodules https://gitlab.com/ChristianPauly/fluffychat-flutter
cd fluffychat-flutter

Android / iOS

  1. For Android install CMake from the SDK Manager

  2. Install ninja:

sudo apt install ninja-build
  1. Outcomment the Google Services plugin at the end of the file android/app/build.gradle:
// apply plugin: "com.google.gms.google-services"
  1. flutter run

Web

  1. flutter channel beta && flutter upgrade

  2. flutter config --enable-web

  3. flutter run

How to add translations for your language

You can use Weblate to translate the app to your language:

https://hosted.weblate.org/projects/fluffychat/

  1. Replace the non-translated string in the codebase:
Text("Hello world"),

with a method call:

Text(L10n.of(context).helloWorld),

And add the method to /lib/l10n/l10n.dart:

String get helloWorld => Intl.message('Hello world');
  1. Add the string to the .arb files with this command:
flutter pub run intl_translation:extract_to_arb --output-dir=lib/l10n lib/l10n/l10n.dart
  1. Copy the new translation objects from /lib/l10n/intl_message.arb to /lib/l10n/intl_<yourlanguage>.arb and translate it or create a new file for your language by copying intl_message.arb.

  2. Update the translations with this command:

flutter pub pub run intl_translation:generate_from_arb --output-dir=lib/l10n --no-use-deferred-loading lib/l10n/l10n.dart lib/l10n/intl_*.arb
  1. Make sure your language is in supportedLocales in /lib/main.dart and in the List at https://gitlab.com/ChristianPauly/fluffychat-flutter/-/blob/main/lib/l10n/l10n.dart#L11.

Special thanks to

  • Fabiyamada is a graphics designer from Brasil and has made the fluffychat logo and the banner. Big thanks for her great designs.

  • Advocatux has made the Spanish translation with great love and care. He always stands by my side and supports my work with great commitment.

  • Thanks to MTRNord and Sorunome for developing.

  • Thanks to Mark for all his support and the chat background.

  • Also thanks to all translators and testers! With your help, fluffychat is now available in more than 12 languages.