Build instructions

This commit is contained in:
Philipp Heckel 2021-11-24 23:16:48 -05:00
parent b389424cec
commit e8b1ba63e8
2 changed files with 20 additions and 7 deletions

View file

@ -3,17 +3,30 @@ This is the Android app for [ntfy](https://github.com/binwiederhier/ntfy) ([ntfy
in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy).
# Releases
You can find the app in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy), or as .apk files on the [releases page](https://github.com/binwiederhier/ntfy-android/releases).
You can find the app in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy),
or as .apk files on the [releases page](https://github.com/binwiederhier/ntfy-android/releases).
There is a ticket to create an [F-Droid version](https://github.com/binwiederhier/ntfy/issues/7), but I haven't had the time yet.
There is a ticket to create an [F-Droid version](https://github.com/binwiederhier/ntfy/issues/7),
but I haven't had the time yet.
# Build instructions
(Todo)
# Build
## Building with your own Firebase Cloud Messaging (FCM) account
## 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:
```
./gradlew assembleFdroidRelease
```
## Building with Firebase (FCM, Google Play flavor)
To build your own version with Firebase, you must:
* Put your own `google-services.json` file in the [app/ folder](https://github.com/binwiederhier/ntfy-android/tree/main/app)
* Create a Firebase/FCM account
* Place your account file at `app/google-services.json`
* And change `app_base_url` in [strings.xml](https://github.com/binwiederhier/ntfy-android/blob/main/app/src/main/res/values/strings.xml)
* Then run:
```
./gradlew assemblePlayRelease
```
## License
Made with ❤️ by [Philipp C. Heckel](https://heckel.io), distributed under the [Apache License 2.0](LICENSE).

View file

@ -7,7 +7,7 @@ buildscript {
dependencies {
classpath 'com.android.tools.build:gradle:4.1.0'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath 'com.google.gms:google-services:4.3.10'
classpath 'com.google.gms:google-services:4.3.10' // This is removed in the "fdroid" flavor
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files