Git Product home page Git Product logo

muhammed-rahif / islam Goto Github PK

View Code? Open in Web Editor NEW
5.0 2.0 0.0 9.14 MB

Quran, Hadiths, Sunnah and Dhikrs in one place! Some of the features are still in development.

Home Page: https://github.com/Muhammed-Rahif/Islam/releases/latest

License: MIT License

TypeScript 86.46% HTML 0.61% JavaScript 2.36% Java 0.87% Swift 2.03% Ruby 0.79% Shell 0.41% SCSS 6.47%
android capacitor cross-platform ionic ios islam reactjs typescript muslim

islam's Introduction

Contributors Forks Stargazers Issues MIT License LinkedIn Telegram


Logo

Islam

Quran, Hadiths, Sunnah and Dhikrs in one place!
Download the latest app »

Screenshots · Report Bug · Request Feature

Table of Contents

About The Project

The Islam Application is a mobile app created for Muslims, offering access to the Quran, Sunnah, and Dhikrs. The app is designed to serve as a valuable resource for Muslims who are looking to enhance their knowledge and practice of Islam.

The app has been developed with the intention of being a source of reward for its contributors. Contributors to the app can earn sadaqah jariyah, a form of ongoing charity that continues to benefit the giver even after they have passed away, by contributing to its development.

The Islam Application has been built using the Ionic iOS theme, and offers both dark and white modes for the user's convenience. We welcome contributions to the app from the community, and encourage contributors to refer to the CONTRIBUTING.md file for guidelines on how to contribute.

We hope that the Islam Application will prove to be a valuable resource for Muslims worldwide, and we welcome your feedback and suggestions on how we can improve the app further.

(back to top)

Features

The Islam Application includes the following features:

  • Read the Holy Quran with 147+ translations
  • Dark and white mode options for reading
  • Built with the Ionic iOS theme for a seamless and responsive experience
  • Location-based prayer times feature provides accurate timings for sunset, sunrise, first third, last third, and midnight times
  • Choose from over 15+ prayer time calculation methods, default to Ummul Qura University
  • Set reminders for prayer times with notifications to never miss a prayer again
  • About screen with contributors list
  • Change font size and font family from 18+ handpicked options
  • Easily switch between reading mode and translations, and move to next or previous chapter or scroll to top of the chapter
  • Sort Quran chapters by Surah no, revelation order, or juzs order
  • Efficient search function for Quran chapters
  • Countdown for the next prayer
  • Display of Hijri and Gregorian date of today.

(back to top)

Getting Started

To get a local copy up and running follow these steps below.

Prerequisites

  • npm or yarn (yarn preferred)
  • nodejs version 18.12+

Installation and running

  1. Install ionic and capcitor globally npm i -g @ionic/cli @capacitor/cli.
  2. Install dependencies yarn install
  3. To start development server locally run ionic serve

Testing

  1. Install playwright browsers yarn playwright install --with-deps chromium chrome
  2. Run test cases yarn playwright test

Contributing

We welcome and greatly appreciate your contributions to the Islam app project. If you're interested in contributing, please refer to the guidelines outlined in the CONTRIBUTING.md file. May Allah (SWT) reward you for your efforts and bless your contributions to this Islamic project.

(back to top)

Join our Telegram community group.

Join our community on Telegram to stay up-to-date with the latest updates of the app, ask questions, and share your feedback and ideas with other members. To join our Telegram group, follow these steps:

Telegram

We look forward to connecting with you on Telegram and hearing your thoughts about our app!

(back to top)

Technologies Used

The Islam project is built using the following technologies:

  • TypeScript
  • React
  • Ionic
  • Capacitor
  • Tailwind CSS
  • Vite
  • Playwright

(back to top)

Contact Author

Gmail Twitter LinkedIn

(back to top)

License

The Islam Application is licensed under the MIT License. See LICENSE.txt for more information.

(back to top)

islam's People

Contributors

dependabot[bot] avatar muhammed-rahif avatar semantic-release-bot avatar sibilrahman avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

islam's Issues

`?chapterName=<surah-name>` should be removed from url

  • http://localhost:8100/quran/1?chapterName=Al-Fatihah. From home screen when clicking on any surah, the surah name is passed to 'view chapter' screen through chapterName param, not a good practice. This should be passed as prop.

  • Addiotionally on view chapter screen, the segment btn (translation/reading) value is better to storing in params. Like http://localhost:8100/quran/1?type=reading

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Unfortunately this error doesn't have any additional information. Feel free to kindly ask the author of the @semantic-release/exec plugin to add more helpful information.


Good luck with your project ✨

Your semantic-release bot 📦🚀

Blank screen when there is no internet.

Describe the bug
When I open the application without internet, I see a blank screen.Instead, it would be better to have a No Internet Available icon or text.

To Reproduce
An icon no or a text no that says No internet available would be better.

Screenshots
Screenshot_20230407-141541_Islam.jpg

App version:
1.3.0

Smartphone :

  • Samsung M02S
  • Android 12
  • Mobile Application

update readme

  • update screenshots
  • update features section; add new features

Prayer times settings

Users should have the following settings:-

  • Select which prayer time method to follow.
  • Select which prayer times should notify

support multiple platforms

Platforms concidering to implement:-

  • Windows
  • Linux

ios and mac, I don't have a apple software development environment, btw if anyone can buy me one, I will appreciate it greatly...🥲

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.