Skip to content

freshplatform/fresh-notes

Repository files navigation

Fresh Notes App

Table of contents

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

Tap to show/hide screenshot

macOS Notes crash

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

  4. Configure Firebase with your Flutter app using the offical documentation, 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:
    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?....

  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)