Skip to content
/ noor Public

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.

License

Notifications You must be signed in to change notification settings

pr-Mais/noor

Repository files navigation

Codemagic build status

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.
  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.

2. Run

  1. Clone the project:
git clone https://github.com/pr-Mais/noor.git
  1. Get packages:
flutter pub get
  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 noorathkarapplication@gmail.com

Credits

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

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Languages