chore: resume and finalize previously staged changes with updates

Author: EchoEllet

CHANGELOG.md

@@ -1,128 +1,7 @@
-# Fresh Notes App
+> [!CAUTION]
 
-## Table of contents
-- [Fresh Notes App](#fresh-notes-app)
-  - [Table of contents](#table-of-contents)
-  - [About](#about)
-    - [Story](#story)
-  - [Setup](#setup)
+> This project is outdated and is no longer supported, it was never production-ready and published, we highly recommend to not use it or explore the code in it due to the code quality.
+> It wasn't meant to be published or a high-quality code project from the start due to some reasons.
+> We recommened that you check other related repostiories.
 
-## About
-A cross-platform, open-source notes app written in Flutter, Kotlin, Swift, Typescript and Firebase
-
-### Story
-We are all interested in building mobile apps for iOS and Android, so we had to use macOS to write and build native iOS applications using Xcode, when using any operating system I usually take a lot of notes and I needed an notes app and I prefer it to not be a third party so I used Notes app on macOS but after updating to macOS 14.1 the notes app never working and it doesn't matter what I do I always getting crashes
-
-<details>
-<summary>Tap to show/hide screenshot</summary>
-<br>
-
-![macOS Notes crash](./assets/images/macos_notes_crash.png)
-
-</details>
-
-it's known to be limited on AppleOS and it's closed so there is not much I can do, so I create this little app and usually I prefer my repositories to public so I decided to also publish it even though that wasn't my plan
-
-## Setup
-1. Setup Flutter, Android Studio, Xcode on your local machine
-2. Run the script `./scripts/fallbacks.sh`
-3. Install the [Firebase CLI](https://firebase.google.com/docs/cli)
-4. Configure Firebase with your Flutter app using the offical [documentation](https://firebase.google.com/docs/flutter/setup), you are welcome to setup it manually, I prefer to do it manually but to make it faster to setup the app for new anyone I will use the automated CLI
-5. Create Firebase Firestore index
-
-    Composite indexes: <br>
-    userId: Ascending  <br>
-    updatedAt: Descending <br>
-    __name__ Descending <br>
-
-    Instead of defining a composite index manually, try to run all the queries in the app by testing everything to get a links for generating the required index. and you will get a url to open Like:
-    [https://console.firebase.google.com/v1/r/project/mynotes-eb717/firestore/indexes?....](https://console.firebase.google.com/v1/r/project/mynotes-eb717/firestore/indexes?create_composite=Cktwcm9qZWN0cy9teW5vdGVzLWViNzE3L2RhdGFiYXNlcy8oZGVmYXVsdCkvY29sbGVjdGlvbkdyb3Vwcy9ub3Rlcy9pbmRleGVzL18QARoKCgZ1c2VySWQQARoNCgl1cGRhdGVkQXQQAhoMCghfX25hbWVfXxAC)
-
-6. Configure App check in firebase for Android and iOS (optional)
-7. Setup App Links for Android and Universal Links for iOS (optional)
-8. Update the `constants.dart` in the scripts folder (optional)
-
-<!-- 1. Firebase: First setup firebase for both android/ios, register the apps and download the configurations and put
-them in the desire place, "google-services.json" for android, ios "GoogleService-Info.plist"
-already ignored in the .gitignore
-
-1. Permissions
-
-    Android:
-        `
-         <uses-feature
-        android:name="android.hardware.camera"
-        android:required="false" />
-
-    <uses-permission android:name="android.permission.INTERNET" />
-    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-    <uses-permission android:name="android.permission.CAMERA" />
-    <uses-permission
-        android:name="android.permission.WRITE_EXTERNAL_STORAGE"
-        android:maxSdkVersion="29" />
-        `
-
-    Ios:
-    "<key>NSCameraUsageDescription</key>
-	<string>We need access to the photo library so you take a photo</string>
-	<key>NSPhotoLibraryUsageDescription</key>
-	<string>We need access to the photo library so you pick image</string>
-	<key>NSPhotoLibraryAddUsageDescription</key>
-	<string>To save images into the library, we need permission from you</string>
-	<key>FirebaseAutomaticScreenReportingEnabled</key>
-	<false/>"
-
-2. Localizations in Android and iOS
-    iOS in info.plist:
-    `
-	<key>CFBundleLocalizations</key>
-	<array>
-		<string>en</string>
-		<string>ar</string>
-	</array>
-    `
-    Android:
-    Create a file called res/xml/locales_config.xml and specify your app's languages, including your app's ultimate fallback locale, which is the locale specified in res/values/strings.xml.
-    `
-    <?xml version="1.0" encoding="utf-8"?>
-    <locale-config xmlns:android="http://schemas.android.com/apk/res/android">
-        <locale android:name="en"/>
-        <locale android:name="ar"/>
-    </locale-config>
-    `
-    In the manifest, add a line pointing to this new file:
-    <manifest>
-        ...
-        <application
-            ...
-            android:localeConfig="@xml/locales_config">
-        </application>
-    </manifest>
-    Specify supported languages in Gradle
-    If not already present, specify the same languages using the resourceConfigurations property in your app's module-level build.gradle file:
-
-    `
-    android {
-        ...
-        defaultConfig {
-            resourceConfigurations += ["en", "ar"]
-        }
-    }
-    `
-
-
-4. Create firebase firestore index
-
-Composite indexes:
-userId: Ascending
-updatedAt: Descending
-__name__ Descending
-
-Instead of defining a composite index manually, try to run all the queries in the app by testing everything to get a links for generating the required index. and you will get a url to open 
-[Like: https://console.firebase.google.com/v1/r/project/mynotes-eb717/firestore/indexes?create_composite=Cktwcm9qZWN0cy9teW5vdGVzLWViNzE3L2RhdGFiYXNlcy8oZGVmYXVsdCkvY29sbGVjdGlvbkdyb3Vwcy9ub3Rlcy9pbmRleGVzL18QARoKCgZ1c2VySWQQARoNCgl1cGRhdGVkQXQQAhoMCghfX25hbWVfXxAC](https://console.firebase.google.com/v1/r/project/mynotes-eb717/firestore/indexes?create_composite=Cktwcm9qZWN0cy9teW5vdGVzLWViNzE3L2RhdGFiYXNlcy8oZGVmYXVsdCkvY29sbGVjdGlvbkdyb3Vwcy9ub3Rlcy9pbmRleGVzL18QARoKCgZ1c2VySWQQARoNCgl1cGRhdGVkQXQQAhoMCghfX25hbWVfXxAC)
-
-5. Configure App check in firebase for Android and iOS
-
-6. configure iOS app notification permissions and etc...
-
-7. Don't forgot to change app name, app icons, notifications icons, branding and applicationId and everything that is releated to this app when republish it again -->
+We might fully rewrite it in the future however it's most likely won't be soon, it will still be supported since some users already installed the pre-alpha version.

CONTRIBUTING.md

@@ -1,27 +1,10 @@
 plugins {
     id "com.android.application"
     id "kotlin-android"
+    // The Flutter Gradle Plugin must be applied after the Android and Kotlin Gradle plugins.
     id "dev.flutter.flutter-gradle-plugin"
 }
 
-def localProperties = new Properties()
-def localPropertiesFile = rootProject.file('local.properties')
-if (localPropertiesFile.exists()) {
-    localPropertiesFile.withReader('UTF-8') { reader ->
-        localProperties.load(reader)
-    }
-}
-
-def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
-if (flutterVersionCode == null) {
-    flutterVersionCode = '1'
-}
-
-def flutterVersionName = localProperties.getProperty('flutter.versionName')
-if (flutterVersionName == null) {
-    flutterVersionName = '1.0'
-}
-
 def keystoreProperties = new Properties()
 def keystorePropertiesFile = rootProject.file('key.properties')
 if (keystorePropertiesFile.exists()) {
@@ -30,39 +13,29 @@ if (keystorePropertiesFile.exists()) {
 
 android {
     namespace "net.freshplatform.fresh_notes"
-//    compileSdkVersion flutter.compileSdkVersion
-    compileSdkVersion 34
-    ndkVersion flutter.ndkVersion
-    // One or more plugins require a higher Android NDK version.
-    ndkVersion "25.1.8937393"
+    compileSdk = flutter.compileSdkVersion
+    ndkVersion = flutter.ndkVersion
 
     compileOptions {
-        coreLibraryDesugaringEnabled true
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
     }
 
     kotlinOptions {
-        jvmTarget = "1.8"
+        jvmTarget = JavaVersion.VERSION_1_8
     }
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
     }
 
-    androidResources {
-//        generateLocaleConfig = true
-    }
-
     defaultConfig {
         applicationId "net.freshplatform.fresh_notes"
-        // You can update the following values to match your application needs.
-        // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
-        minSdkVersion 23
-        targetSdkVersion 34
-        targetSdkVersion flutter.targetSdkVersion
-        versionCode flutterVersionCode.toInteger()
-        versionName flutterVersionName
+        // TODO: Use flutter.minSdkVersion once remove super_clipboard
+        minSdk = 23
+        targetSdk = flutter.targetSdkVersion
+        versionCode = flutter.versionCode
+        versionName = flutter.versionName
     }
 
     signingConfigs {
@@ -93,29 +66,10 @@ android {
         }
     }
 
-//    buildFeatures {
-//        compose true
-//    }
-//    composeOptions {
-//        kotlinCompilerExtensionVersion "1.5.1"
-//    }
-
 }
 
 flutter {
     source '../..'
 }
 
-dependencies {
-//    implementation "androidx.glance:glance:1.0.0"
-//    implementation "androidx.glance:glance-appwidget:1.0.0"
-//    implementation "androidx.glance:glance-material3:1.0.0"
-
-    // Flutter local notifications:
-    //noinspection GradleDependency
-    implementation 'androidx.window:window:1.0.0'
-    //noinspection GradleDependency
-    implementation 'androidx.window:window-java:1.0.0'
-    //noinspection GradleDependency
-    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.2.2'
-}
+dependencies {}

README.md

@@ -5,18 +5,11 @@
     <uses-feature
         android:name="android.hardware.camera"
         android:required="false" />
+    <uses-feature
+        android:name="android.hardware.camera.autofocus"
+        android:required="false" />
 
     <uses-permission android:name="android.permission.INTERNET" />
-    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-    <uses-permission android:name="android.permission.CAMERA" />
-    <uses-permission
-        android:name="android.permission.WRITE_EXTERNAL_STORAGE"
-        android:maxSdkVersion="32"
-        tools:ignore="ScopedStorage" /> <!-- schedule notifications -->
-    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
-    <uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />
-    <uses-permission android:name="android.permission.USE_EXACT_ALARM" />
-    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
 
     <application
         android:name="${applicationName}"
@@ -72,24 +65,6 @@
             android:name="flutterEmbedding"
             android:value="2" />
 
-        <!-- Flutter Local Notifications Plugin -->
-
-        <receiver
-            android:name="com.dexterous.flutterlocalnotifications.ScheduledNotificationReceiver"
-            android:exported="false" />
-        <receiver
-            android:name="com.dexterous.flutterlocalnotifications.ScheduledNotificationBootReceiver"
-            android:exported="false">
-            <intent-filter>
-                <action android:name="android.intent.action.BOOT_COMPLETED" />
-                <action android:name="android.intent.action.MY_PACKAGE_REPLACED" />
-                <action android:name="android.intent.action.QUICKBOOT_POWERON" />
-                <action android:name="com.htc.intent.action.QUICKBOOT_POWERON" />
-            </intent-filter>
-        </receiver>
-
-        <!-- Super clipboard Plugin -->
-
         <provider
             android:name="com.superlist.super_native_extensions.DataProvider"
             android:authorities="net.freshplatform.fresh_notes.SuperClipboardDataProvider"

android/app/build.gradle

@@ -1,28 +1,16 @@
-buildscript {
-    ext.kotlin_version = '1.7.10'
-    repositories {
-        google()
-        mavenCentral()
-    }
-
-    dependencies {
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-    }
-}
-
 allprojects {
     repositories {
         google()
         mavenCentral()
     }
 }
 
-rootProject.buildDir = '../build'
+rootProject.buildDir = "../build"
 subprojects {
     project.buildDir = "${rootProject.buildDir}/${project.name}"
 }
 subprojects {
-    project.evaluationDependsOn(':app')
+    project.evaluationDependsOn(":app")
 }
 
 tasks.register("clean", Delete) {

android/app/src/main/AndroidManifest.xml

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-all.zip