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.

Last update: Dec 22, 2022

Overview

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.

Create a new Firebase project.
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.
Go to Remote Config page.
Add a new parameter with name noorThker, with any value of your choice.
Go to Cloud Messaging page, and enable it for your project.
(Soon) ~~follow the steps in this repo, which contains the backend function that will be triggered whenevr you update the Remote Config value from the console.~~

2. Run

Clone the project:

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

Get packages:

flutter pub get

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.

Comments

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

Run the app on iOS

Phone:

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

bug

opened by pr-Mais 3

Refactor notifications
Hi, i made two changes in this PR.

Change subtitleWithIcon functional widget to statless widget to make it reusable by another items.

Refactor notifications parts.
opened by ibrahimSam 2

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.

opened by Abdullah104 1

Enhance README and add clear setup steps
Description:

README file is missing steps to clone and run the project successfully.

Firebase setup needs to link to the backend function used with Remote Config & FCM.

documentation enhancement
opened by pr-Mais 0
Migrate to null-safety
closes #1

Major enhancements:

Mainly, migrated to null-safety.

Renamed many components to more descriptive names.

Changed the initialization and DI of DataModel.

Added 80-columns rule.

Separated the single data file into multiple files.
opened by pr-Mais 0
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

opened by ahmed-tasaly 3
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.
enhancement

opened by pr-Mais 0

Releases(2.5.0)

2.5.0(May 16, 2022)
What's Changed

feat: Subha new features by @pr-Mais in https://github.com/pr-Mais/noor/pull/15

Analyzer by @Abdullah104 in https://github.com/pr-Mais/noor/pull/14

New Contributors

@Abdullah104 made their first contribution in https://github.com/pr-Mais/noor/pull/14

Full Changelog: https://github.com/pr-Mais/noor/compare/2.4.0...2.5.0
Source code(tar.gz)
Source code(zip)
2.4.0(Jun 18, 2021)
What's Changed

Migrate to null-safety by @pr-Mais in https://github.com/pr-Mais/noor/pull/2

Rewrite overview in README file by @Maryom in https://github.com/pr-Mais/noor/pull/4

New Contributors

@Maryom made their first contribution in https://github.com/pr-Mais/noor/pull/4

Full Changelog: https://github.com/pr-Mais/noor/commits/2.4.0
Source code(tar.gz)
Source code(zip)

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.

Related tags

Overview

Overview

App Preview

How to run

1. Firebase Setup

2. Run

Want to contribute?

Credits

Comments

Description:

Major enhancements:

السلام عليكم

Releases(2.5.0)

2.5.0(May 16, 2022)

What's Changed

New Contributors

2.4.0(Jun 18, 2021)

What's Changed

New Contributors

Owner

Mais Alheraki

Contact Book UI designed with Flutter

A simple app to keep track the time you Learn, Playing, Reading, ... in every week. This is also my attempt to teach myself Flutter & Dart

An app to help students and teachers connect each other.

A digital BookShelf for your reading progress.

A multi-plateform (Flutter) application for reading your emails, with your favorite devices, using the JMAP protocol!

Flutter Catalog is a very handy catalog of beautifully designed widgets to help ease your flutter journey.

A new Flutter project. Blood Buddy is a mobile application designed to facilitate communication between donors and blood needs.

Flutter Web application having splash screen and providing Web view Using web view packege.

A Package providing Core functionality/Template to start off a Clean Architecture based project

The FlexGrid control provides a powerful and quickly way to display data in a tabular format. It is including that frozened column/row,loading more, high performance and better experience in TabBarView/PageView.

A package that lets you include a cool, nice looking and validated Password TextFormField in your app to enhance user experience. The package is fully & easily modifiable.

Stream Feed official Flutter SDK. Build your own feed experience using Dart and Flutter.

Pensil Community official Flutter SDK. Build your own community experience using Dart and Flutter.

Kite is the chat app with the most minimalist user experience.

An end-to-end Flutter app built to get details and trending recipes - made as a part of the book 'Flutter Apprentice' by raywenderlich.com

Microsoft Teams Clone is a Video conference application with a rich integrated chat experience, to connect with friends,family & colleagues. Developed as a redesign of Microsoft Teams during my menteeship at Microsoft Engage 2021

Enhancing your WhatsApp experience.

FileManager is a wonderful widget that allows you to manage files and folders, pick files and folders, and do a lot more. Designed to feel like part of the Flutter framework.

Developed a Group chat application using Flutter and Firebase, where users can register and create groups or join already existing groups and start conversing with each other.