2021-10-25 21:14:09 -04:00
# ntfy Android App
2022-02-05 19:33:29 -05:00
This is the Android app for [ntfy ](https://github.com/binwiederhier/ntfy ) ([ntfy.sh ](https://ntfy.sh )). You can find the app in [F-Droid ](https://f-droid.org/packages/io.heckel.ntfy/ ) or the [Play Store ](https://play.google.com/store/apps/details?id=io.heckel.ntfy ),
2021-11-24 23:16:48 -05:00
or as .apk files on the [releases page ](https://github.com/binwiederhier/ntfy-android/releases ).
2021-11-23 23:18:17 -05:00
2021-11-24 23:16:48 -05:00
# Build
2021-11-23 23:18:17 -05:00
2021-11-24 23:16:48 -05:00
## Building without Firebase (F-Droid flavor)
Without Firebase, you may want to still change the default `app_base_url` in [strings.xml ](https://github.com/binwiederhier/ntfy-android/blob/main/app/src/main/res/values/strings.xml )
if you're self-hosting the server. Then run:
```
2021-11-29 15:28:05 -05:00
# To build an unsigned .apk (app/build/outputs/apk/fdroid/*.apk)
2021-11-24 23:16:48 -05:00
./gradlew assembleFdroidRelease
2021-11-29 15:28:05 -05:00
# To build a bundle .aab (app/fdroid/release/*.aab)
./gradlew bundleFdroidRelease
2021-11-24 23:16:48 -05:00
```
## Building with Firebase (FCM, Google Play flavor)
2021-11-23 23:18:17 -05:00
To build your own version with Firebase, you must:
2021-11-24 23:16:48 -05:00
* Create a Firebase/FCM account
* Place your account file at `app/google-services.json`
2021-11-23 23:18:17 -05:00
* And change `app_base_url` in [strings.xml ](https://github.com/binwiederhier/ntfy-android/blob/main/app/src/main/res/values/strings.xml )
2021-11-24 23:16:48 -05:00
* Then run:
```
2021-11-29 15:28:05 -05:00
# To build an unsigned .apk (app/build/outputs/apk/play/*.apk)
2021-11-24 23:16:48 -05:00
./gradlew assemblePlayRelease
2021-11-29 15:28:05 -05:00
# To build a bundle .aab (app/play/release/*.aab)
./gradlew bundlePlayRelease
2021-11-24 23:16:48 -05:00
```
2021-11-23 23:18:17 -05:00
2022-03-28 11:06:01 -04:00
## Translations
We're using [Weblate ](https://hosted.weblate.org/projects/ntfy/ ) to translate the ntfy Android app. We'd love your participation.
< a href = "https://hosted.weblate.org/engage/ntfy/" >
< img src = "https://hosted.weblate.org/widgets/ntfy/-/multi-blue.svg" alt = "Translation status" / >
< / a >
2021-10-25 21:14:09 -04:00
## License
Made with ❤️ by [Philipp C. Heckel ](https://heckel.io ), distributed under the [Apache License 2.0 ](LICENSE ).
2021-10-25 09:01:10 -04:00
2021-10-29 21:13:58 -04:00
Thank you to these fantastic resources:
2021-10-25 21:14:09 -04:00
* [RecyclerViewKotlin ](https://github.com/android/views-widgets-samples/tree/main/RecyclerViewKotlin ) (Apache 2.0)
* [Just another Hacker News Android client ](https://github.com/manoamaro/another-hacker-news-client ) (MIT)
2021-10-29 21:13:58 -04:00
* [Android Room with a View ](https://github.com/googlecodelabs/android-room-with-a-view/tree/kotlin ) (Apache 2.0)
* [Firebase Messaging Example ](https://github.com/firebase/quickstart-android/blob/7147f60451b3eeaaa05fc31208ffb67e2df73c3c/messaging/app/src/main/java/com/google/firebase/quickstart/fcm/kotlin/MyFirebaseMessagingService.kt ) (Apache 2.0)
2021-11-02 21:43:31 -04:00
* [Designing a logo with Inkscape ](https://www.youtube.com/watch?v=r2Kv61cd2P4 )
2021-11-13 19:26:37 -05:00
* [Foreground service ](https://robertohuertas.com/2019/06/29/android_foreground_services/ )
2021-11-28 21:47:00 -05:00
* [github/gemoji ](https://github.com/github/gemoji ) (MIT) for as data source for an up-to-date [emoji.json ](https://raw.githubusercontent.com/github/gemoji/master/db/emoji.json ) file
* [emoji-java ](https://github.com/vdurmont/emoji-java ) (MIT) has been stripped and inlined to use the emoji.json file
