fluffychat/README.md

161 lines
5.0 KiB
Markdown
Raw Normal View History

2020-02-23 10:06:01 +01:00
![](https://i.imgur.com/wi7RlVt.png)
<p align="center">
<a target="new" href="https://play.google.com/store/apps/details?id=chat.fluffy.fluffychat">
2021-01-17 08:56:07 +01:00
<img height="66px" src="https://fluffychat.im/assets/images/google-play-badge.png" />
2020-02-23 10:06:01 +01:00
</a>
2020-07-01 20:55:00 +02:00
<a target="new" href="https://fluffychat.im/en/fdroid.html">
2021-01-17 08:56:07 +01:00
<img height="66px" src="https://fluffychat.im/assets/images/fdroid_button.png " />
2020-02-23 10:06:01 +01:00
</a>
<br>
2021-01-20 08:44:22 +01:00
<a href="https://web.fluffychat.im" target="new">Open FluffyChat in the browser</a> - <a href="https://matrix.to/#/#fluffychat:matrix.org" target="new">Join the community</a> - <a href="https://metalhead.club/@krille" target="new">Follow me on Mastodon</a> - <a href="https://hosted.weblate.org/projects/fluffychat/" target="new">Translate FluffyChat</a> - <a href="https://gitlab.com/ChristianPauly/fluffychat-website" target="new">Translate the website</a> - <a href="https://fluffychat.im" target="new">Website</a> - <a href="https://gitlab.com/ChristianPauly/fluffychat-flutter/-/jobs/artifacts/main/browse?job=build_android_apk" target="new">Download latest APK</a> - <a href="https://gitlab.com/famedly/famedlysdk" target="new">Famedly Matrix SDK</a> - <a href="https://famedly.com/kontakt">Server hosting and professional support</a>
2020-02-23 10:06:01 +01:00
</p>
<br>
<br>
# Features
* Single and group chats
* Send images and files
2020-09-29 08:45:02 +02:00
* Voice messages
2020-02-23 10:06:01 +01:00
* 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
2020-02-23 10:08:22 +01:00
* Change chat & user avatars
2020-02-23 10:06:01 +01:00
* Archived chats
* Discover public chats on the user's homeserver
2020-02-23 10:08:22 +01:00
* Registration
2020-09-29 08:45:02 +02:00
* Disable account
* Change password
* End-To-End-Encryption
2020-01-03 18:41:50 +01:00
2020-10-10 12:22:08 +02:00
# How to build
2020-01-01 19:10:13 +01:00
2020-01-03 09:28:17 +01:00
1. [Install flutter](https://flutter.dev)
2020-01-01 19:10:13 +01:00
2020-02-23 10:06:01 +01:00
2. Clone the repo:
```
git clone --recurse-submodules https://gitlab.com/famedly/fluffychat
cd fluffychat
2020-02-23 10:06:01 +01:00
```
2020-01-01 19:10:13 +01:00
2020-10-10 12:22:08 +02:00
3. Choose your target platform below and enable support for it.
2020-01-03 09:28:17 +01:00
2020-10-10 12:22:08 +02:00
4. Debug with: `flutter run`
2020-02-23 10:12:31 +01:00
2020-10-10 12:22:08 +02:00
### Android
* Install CMake from the SDK Manager
* Install ninja:
2020-02-23 10:12:31 +01:00
```
sudo apt install ninja-build
```
2020-10-10 12:22:08 +02:00
* Build with: `flutter build apk`
### iOS / iPadOS
* With xcode you can't build a release version without our cert. :-/ Use `flutter run --profile` to have a working version on your iOS device.
2020-01-03 09:28:17 +01:00
### Web
2020-10-10 12:22:08 +02:00
* Enable web support in Flutter: https://flutter.dev/docs/get-started/web
2020-12-11 14:14:33 +01:00
* Optionally edit the file `lib/app_config.dart`. If you e.g. only want to change the default homeserver, then only modify the `defaultHomeserver` key.
2020-11-08 20:42:35 +01:00
* Build with:
```bash
./scripts/prepare-web.sh
flutter clean
flutter pub get
flutter build web --release --verbose
```
2020-12-18 11:43:13 +01:00
* Optionally configure by serving a `config.json` at the same path as fluffychat.
An example can be found at `config.sample.json`. None of these
values have to exist, the ones stated here are the default ones. If you e.g. only want
to change the default homeserver, then only modify the `default_homeserver` key.
2020-10-10 12:22:08 +02:00
### Desktop (Linux, Windows, macOS)
* Enable Desktop support in Flutter: https://flutter.dev/desktop
2020-11-08 20:42:35 +01:00
* Build with one of these:
```bash
2020-10-10 12:22:08 +02:00
flutter build linux --release
flutter build windows --release
flutter build macos --release
```
2020-01-03 09:28:17 +01:00
2020-01-20 09:50:49 +01:00
## How to add translations for your language
2020-06-20 12:09:19 +02:00
You can use Weblate to translate the app to your language:
https://hosted.weblate.org/projects/fluffychat/
2021-01-20 17:27:07 +01:00
If you want to get your translated strings approved, please ask in our
<a href="https://matrix.to/#/#fluffychat:matrix.org" target="new">support room</a>!
2020-06-20 12:09:19 +02:00
2020-01-20 09:50:49 +01:00
1. Replace the non-translated string in the codebase:
```
Text("Hello world"),
```
with a method call:
```
2020-05-07 07:52:40 +02:00
Text(L10n.of(context).helloWorld),
2020-01-20 09:50:49 +01:00
```
and add the following import if missing:
2020-01-20 09:50:49 +01:00
```
import 'package:flutter_gen/gen_l10n/l10n.dart';
2020-01-20 09:50:49 +01:00
```
2. Add the string to `/lib/l10n/l10n_en.arb`:
2020-01-20 09:50:49 +01:00
(The following example need to be sorounded by the usual json `{}` and after the `@@locale` key)
Example A:
2020-01-20 09:50:49 +01:00
```
"helloWorld": "Hello World!",
"@helloWorld": {
"description": "The conventional newborn programmer greeting"
}
2020-01-20 09:50:49 +01:00
```
Example B:
```
"hello": "Hello {userName}",
"@hello": {
"description": "A message with a single parameter",
"placeholders": {
"userName": {
"type": “String”,
“example”: “Bob”
}
}
}
```
2020-02-23 10:06:01 +01:00
3. For testing just run a regular build without extras
2020-02-23 10:06:01 +01:00
# Special thanks to
* <a href="https://github.com/fabiyamada">Fabiyamada</a> is a graphics designer from Brasil and has made the fluffychat logo and the banner. Big thanks for her great designs.
* <a href="https://github.com/advocatux">Advocatux</a> 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.
2021-01-20 19:53:19 +01:00
* <a href="https://github.com/googlefonts/noto-emoji/">Noto Emoji Font</a> for the awesome emojis.