General improvements and bugfixes

Author: lucasdillmann

.github/workflows/firefly-companion.yml

@@ -27,6 +27,14 @@ jobs:
       - name: Gradle cache
         uses: gradle/actions/setup-gradle@v4
 
+      - name: Prepare signing keystore
+        run: |
+          echo "${{ secrets.ANDROID_KEYSTORE_BASE64 }}" | base64 -d > keystore.jks
+          echo "ANDROID_KEYSTORE_PATH=$PWD/keystore.jks" >> $GITHUB_ENV
+          echo "ANDROID_KEYSTORE_PASSWORD=${{ secrets.ANDROID_KEYSTORE_PASSWORD }}" >> $GITHUB_ENV
+          echo "ANDROID_KEY_ALIAS=${{ secrets.ANDROID_KEY_ALIAS }}" >> $GITHUB_ENV
+          echo "ANDROID_KEY_PASSWORD=${{ secrets.ANDROID_KEY_PASSWORD }}" >> $GITHUB_ENV
+
       - name: Build Release APK
         run: ./gradlew :android:assembleRelease --stacktrace --no-daemon
 

.gitignore

@@ -16,3 +16,4 @@ local.properties
 .kotlin/
 **/*.private.env.json
 .idea/
+firefly-companion.keystore

README.md

@@ -0,0 +1,19 @@
+<h1 align="center">
+    Firefly Companion
+</h1>
+<p align="center">
+    <img src="docs/firefly-companion-screens.png" alt="" />
+</p>
+
+An unofficial Android companion app for Firefly III — the open‑source, self‑hosted personal finance manager.
+This project aims to provide an intuitive, mobile‑first experience to browse your balances, accounts, and transactions,
+perform common actions on the go, gain insights from an integrated AI‑powered personal finance assistant, and more.
+
+Please note that this project is highly opinionated and is intended as an on‑the‑go companion for quick actions.
+Not all Firefly III features will be available by design.
+
+To get started, check the Releases page and download the APK file. The app will guide you through connecting to your
+Firefly III server and getting started.
+
+For now, suggestions, issues, and pull requests will not be accepted, but feel free to fork the repository and modify
+the app to best fit your needs.

android/build.gradle.kts

@@ -47,10 +47,39 @@ android {
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     }
 
+    signingConfigs {
+        val keystorePath = System.getenv("ANDROID_KEYSTORE_PATH")
+        val keystorePassword = System.getenv("ANDROID_KEYSTORE_PASSWORD")
+        val keyAlias = System.getenv("ANDROID_KEY_ALIAS")
+        val keyPassword = System.getenv("ANDROID_KEY_PASSWORD")
+        val enableSigning =
+            !keystorePath.isNullOrBlank() &&
+                !keystorePassword.isNullOrBlank() &&
+                !keyAlias.isNullOrBlank() &&
+                !keyPassword.isNullOrBlank()
+
+        if (enableSigning) {
+            register("release") {
+                storeFile = file(keystorePath!!)
+                storePassword = keystorePassword
+                this.keyAlias = keyAlias
+                this.keyPassword = keyPassword
+                enableV1Signing = true
+                enableV2Signing = true
+                enableV3Signing = true
+                enableV4Signing = true
+            }
+        }
+    }
+
     buildTypes {
         release {
-            isMinifyEnabled = true
+            isMinifyEnabled = false
             proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
+
+            val hasReleaseSigning = signingConfigs.findByName("release") != null
+            if (hasReleaseSigning)
+                signingConfig = signingConfigs.getByName("release")
         }
     }
 

android/src/main/kotlin/br/com/dillmann/fireflycompanion/android/core/router/Navigator.kt

@@ -3,5 +3,5 @@ package br.com.dillmann.fireflycompanion.android.core.router
 import java.io.Serializable
 
 fun navigate(route: Route, bag: Serializable? = null) {
-    RouterState.stack + NavigationEvent(route, bag)
+    RouterState.stack += NavigationEvent(route, bag)
 }

android/src/main/kotlin/br/com/dillmann/fireflycompanion/android/onboarding/components/OnboardingServerFormHeader.kt

@@ -16,7 +16,7 @@ fun OnboardingServerFormHeader() {
         text = i18n(R.string.onboarding_server_title),
         style = MaterialTheme.typography.headlineMedium,
         textAlign = TextAlign.Left,
-        modifier = Modifier.padding(top = 64.dp, bottom = 16.dp)
+        modifier = Modifier.padding(top = 96.dp, bottom = 16.dp)
     )
 
     Text(

business/src/main/kotlin/br/com/dillmann/fireflycompanion/business/subscription/Subscription.kt

@@ -15,5 +15,5 @@ data class Subscription(
     data class Payment(
         val paidAt: LocalDate,
         val amount: BigDecimal,
-    )
+    ) : Serializable
 }