pr-mais / noor

Noor is a mobile app designed to help in providing a comfortable reading experience for Muslims, by referencing the book "Hisnul Muslim", and some other references.

Noor App | تطبيق نُور

Overview

Noor is an islamic mobile app, consists of four main pages: home, favorite, alsabha, and settings. The data is structured in Cards that are easy to read, and has some actions that can be performed with the card content. Noor is designed to help in providing a comfortable reading experience for Muslims, by referencing the book "Hisnul Muslim", and some other references.

This project contains the codebase for the Android version that is on Play Store, it can run on iOS as well. Built with Flutter, and Firebase.

App Preview

How to run

Note: the assets were replaced by placeholders, so the version you will run locally is different in look than the version in stores.

1. Firebase Setup

It's important to put your own Firebase service file in order to run the app, as it uses Remote Config and Firebase Messaging.

1. Create a new Firebase project.
2. Add a new Android or iOS app, depending on which device you want to use, and follow the configuration steps to connect Noor to your Firebase project. This could help: https://firebase.google.com/docs/flutter/setup
3. Go to Remote Config page.
4. Add a new parameter with name noorThker, with any value of your choice.
5. Go to Cloud Messaging page, and enable it for your project.
6. To setup the cloud function that trigger a notification each time the Remote Config variable changes on the console, find the code in this repo.

NOTE: You can't really run the app without it, so make sure to set it up.

The app needs some files generated the flutterfire_cli, specifically lib/firebase_options.dart, android/app/google-services.json, and ios/Runner/GoogleService-Info.plist.

So make sure to follow the link in step 2 if you haven't already.

2. (optional) FVM Setup

FVM is used to make sure everyone working on the project uses the same version. It is also easier to maintain since the .fvmrc file has the config you need to get started quickly.

It also makes it easy for Noor to stay on an older version without needing to do lots of upgrades and downgrades, since developers usually work on projects with different versions.

FVM website: https://fvm.app/

Once FVM is installed, run the following command to get things ready:

fvm use 3.22.1

Be sure to check .fvmrc for the correct version this project uses, in case the version above is old.

3. Run

1. Clone the project:

git clone https://github.com/pr-Mais/noor.git

2. Get packages:

flutter pub get

3. (for android only) Edit the android/app/build.gradle:

This will allow you to sign the app with the debug keystore, no need to make a keystore just for development :D

- // signingConfig signingConfigs.debug
- signingConfig signingConfigs.release
+ signingConfig signingConfigs.debug
+ // signingConfig signingConfigs.release

1. Run:

flutter run

Want to contribute?

If you encounter any bug while using the apps in store, or running it locally, please file an issue.
Contribution for enhancments are also welcome! just create a PR, and describe precisly what is your contribution.

For features request, contact us on [email protected]

Credits

Shout out to the amazing designer Shaikha Alqahtani.
The iOS version from Noor was made with native Swift by Maryam Aljamea.

noor's Issues

Settings tab code is messy and needs refactoring

Describe the enhancement
The settings.dart file.

Goal
To have a shorter, clear readable file. This might include splitting some code and introduce new files.

Android's back button doesn't exit the app

feature request : azkar reminder "Floating"

السلام عليكم

1- Can you add feature of a floating azkar that appear on the screen every interval of time like that in
https://play.google.com/store/apps/details?id=com.revanen.athkar
..

..

thanks in advance
@pr-Mais

Enhance README and add clear setup steps

Description:

1. README file is missing steps to clone and run the project successfully.
2. Firebase setup needs to link to the backend function used with Remote Config & FCM.

Migrate to Null Safety

Firebase configurations files not found

I just forked the repository and tried to run it. But the Firebase configuration files for Android and IOS are missing from the repo., thus the app won't run on either of the platforms.

Error log on Android

   FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':app:processDebugGoogleServices'.
> File google-services.json is missing. The Google Services Plugin cannot function without it. 
Searched Location: 
/Users/abdullah/Documents/community/noor/android/app/src/nullnull/google-services.json
/Users/abdullah/Documents/community/noor/android/app/src/debug/google-services.json
/Users/abdullah/Documents/community/noor/android/app/src/nullnullDebug/google-services.json
/Users/abdullah/Documents/community/noor/android/app/src/nullnull/debug/google-services.json
/Users/abdullah/Documents/community/noor/android/app/src/debug/nullnull/google-services.json
/Users/abdullah/Documents/community/noor/android/app/google-services.json

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 5s
Exception: Gradle task assembleDebug failed with exit code 1

Error log on IOS

 Failed to build iOS app
Error output from Xcode build:
↳
 --- xcodebuild: WARNING: Using the first of multiple matching destinations:
 { platform:iOS Simulator, id:dvtdevice-DVTiOSDeviceSimulatorPlaceholder-iphonesimulator:placeholder, name:Any iOS Simulator Device }
 { platform:iOS Simulator, id:6DA6DD93-9A8F-4FF3-AD4A-708F15E82A41, OS:15.0, name:iPad (9th generation) }
 { platform:iOS Simulator, id:439A5CCF-4283-4A26-9971-F1EE98C33E28, OS:15.0, name:iPad Air (4th generation) }
 { platform:iOS Simulator, id:176B4A1A-9242-4400-9A21-658F67688786, OS:15.0, name:iPad Pro (9.7-inch) }
 { platform:iOS Simulator, id:237FDADF-6CA1-4B05-92CD-7C9A71DDE158, OS:15.0, name:iPad Pro (11-inch) (3rd generation) }
 { platform:iOS Simulator, id:AE4838F2-326C-4E9E-850A-8964359A6DC7, OS:15.0, name:iPad Pro (12.9-inch) (5th generation) }
 { platform:iOS Simulator, id:FD7F438F-92B0-4C70-99AD-4F18EA13FCF0, OS:15.0, name:iPad mini (6th generation) }
 { platform:iOS Simulator, id:97165949-68C2-42A8-91D4-4F61A7C8F2FD, OS:15.0, name:iPhone 8 }
 { platform:iOS Simulator, id:0D36AA16-AFA0-4327-AE44-D1E469721F1A, OS:15.0, name:iPhone 8 Plus }
 { platform:iOS Simulator, id:DFE58071-432E-45DD-9707-399F82135C41, OS:15.0, name:iPhone 11 }
 { platform:iOS Simulator, id:6F722B98-0CE6-4719-BA34-34B00F0BD0B5, OS:15.0, name:iPhone 11 Pro }
 { platform:iOS Simulator, id:6A4595B5-2186-4D76-A8E7-05E097E413AB, OS:15.0, name:iPhone 11 Pro Max }
 { platform:iOS Simulator, id:3AD86330-9573-4C6D-A679-CE044EAA8F84, OS:15.0, name:iPhone 12 }
 { platform:iOS Simulator, id:02E6556D-EBBD-4813-940D-85F59D218C2B, OS:15.0, name:iPhone 12 Pro }
 { platform:iOS Simulator, id:C892E986-669D-4919-85DE-E85808B72B0A, OS:15.0, name:iPhone 12 Pro Max }
 { platform:iOS Simulator, id:88A461F8-85EF-41CA-999E-8BF32C114DB3, OS:15.0, name:iPhone 12 mini }
 { platform:iOS Simulator, id:D880E76F-647E-4F2B-A469-5EBCC4003F38, OS:15.0, name:iPhone 13 }
 { platform:iOS Simulator, id:96A74862-EC5A-4423-82DD-B79150269C04, OS:15.0, name:iPhone 13 Pro }
 { platform:iOS Simulator, id:7A22AA0F-7F53-4683-9AD2-ACB07F02557C, OS:15.0, name:iPhone 13 Pro Max }
 { platform:iOS Simulator, id:B7AAFF04-2F0F-43D2-A360-B235597E6EE9, OS:15.0, name:iPhone 13 mini }
 { platform:iOS Simulator, id:F5BD755D-A3F6-4F3F-9005-EC16C7561BCD, OS:15.0, name:iPhone SE (2nd generation) }
 { platform:iOS Simulator, id:CB9291CF-E689-475C-8F3B-A5FB568F0F2B, OS:15.0, name:iPod touch (7th generation) }
 { platform:macOS, arch:arm64, variant:Designed for [iPad,iPhone], id:00006000-0016516E3CD8801E }
 { platform:iOS, id:dvtdevice-DVTiPhonePlaceholder-iphoneos:placeholder, name:Any iOS Device }
 ** BUILD FAILED **
Xcode's output:
↳
 error: Build input file cannot be found: '/Users/abdullah/Documents/community/noor/GoogleService-Info.plist' (in target 'Runner' from project 'Runner')
 note: Using new build system
 note: Planning
 note: Build preparation complete
 note: Building targets in parallel
Could not build the application for the simulator.
Error launching application on iPhone 13.

If possible, please add the Firebase configuration files to the repo.

RemoteConfig isn't being fetched on iOS simulator

Describe the bug
Once the app starts on iOS, it fails to fetch the remote config value in Home with following log:

flutter: [firebase_remote_config/internal] internal remote config fetch error
#0      StandardMethodCodec.decodeEnvelope
package:flutter/…/services/message_codecs.dart:597
#1      MethodChannel._invokeMethod
package:flutter/…/services/platform_channel.dart:158
<asynchronous suspension>
#2      MethodChannelFirebaseRemoteConfig.fetchAndActivate
package:firebase_remote_config_platform_interface/…/method_channel/method_channel_firebase_remote_config.dart:145
<asynchronous suspension>
#3      RemoteConfig.fetchAndActivate
package:firebase_remote_config/src/remote_config.dart:86
<asynchronous suspension>
#4      RemoteConfigService.fetchNoorRC
package:noor/services/remote_config.dart:31
<asynchronous suspension>
#5      _AnimatedHeaderState._loadRemoteConfig
package:noor/…/1_home/home.dart:348
<asynchronous suspension>

To Reproduce

1. Run the app on iOS

Phone:

• Device: iOS simulator
• OS: iOS 14.5
• App Version: 2.4.0

Helle

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Phone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• App Version: [e.g. 1.0.1]

Additional context
Add any other context about the problem here.