Skip to content

Latest commit

 

History

History
303 lines (201 loc) · 8.08 KB

README.md

File metadata and controls

303 lines (201 loc) · 8.08 KB
Raw

This project is an English verison of the original Al-Taqwaa app.

preview|690x388

Contents

App Features


  • The Noble Quran text and audio
  • A large collection of adhkar for morning, evening, daily life, sleep, and prayer
  • Various praises and supplications
  • Hisnul Muslim (Fortress of the Muslim)
  • English translation and transliteration available for Quran and Adhkar
  • Prayer times according to your location coordinates and time zone
  • Various methods of calculating prayer times (Umm al-Qura, Muslim World League and more...)
  • Audio notification (for the call to prayer)
  • Audio notification of morning and evening dhikr at a user-specific time
  • Download content to local directory for offline use
  • Customizable settings and user-interface
  • Modern, user-friendly design with light and dark modes
  • Completely free and open source under the GNU General Public License GPL-3.0
  • Support for Windows, Mac, and Linux operating systems

Screenshots


Dark Mode Light Mode
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa
altaqwaa altaqwaa

Settings

altaqwaa


Download


Installation

  • Windows: Run Altaqwaa.Setup.{ver}.exe or Altaqwaa.{ver}.msi and follow onscreen prompts. Once installed, the app should be accessible from the start menu.

  • MacOS: Run Altaqwaa-{ver}.dmg and drag icon into Applications folder.

  • Linux: Can be installed through multiple methods

    • Appimage: Run the .Appimage file to launch app

    • Debian: cd into location of .deb file and run command: sudo dpkg -i altaqwaa_{ver}_amd64.deb

    • Snap: cd into location of .snap file and run command: sudo snap install --devmode altaqwaa_{ver}_amd64.snap

    • Tar: cd into location of .tar.gz file and run:

    tar -xzf altaqwaa-{ver}.tar.gz
cd altaqwaa-{ver}
altaqwaa

    Installation via DEB or SNAP: Can launch app by running altaqwaa from any terminal or from Applications list in GUI.


FAQs

  • Is there a version of Altaqwaa for Android systems?

    Yes, you can find the repo for the Andriod version here.

  • What are the sources of content used in Altaqwaa?

    Altaqwaa is built with complete transparency and all sources used can be found here with accompanying links to the original data.

Contribute to the project

There are several ways to contribute to the Altaqwaa project:

  1. Contributing to the development process

    • Altaqwaa is build using the ElectronJS framework.
    • The majority of development involves work in Node.js and underlying languages HTML/CSS/JS.
    • If you have sufficient experience within this framework, please contact a contributor.

  2. Report issues on GitHub page here

    • Please provide a clear and descriptive title of the issue.
    • Include devise specifications and operating system (and distribution/interface used for Linux users).
    • Detailed description of the issue and steps to reproduce.

  3. Support the originial project financially through Github Sponsors from here

  4. Suggest new features and improvements

    • Contact a contributor with details on your idea to improve future Altaqwaa.
    • Open a new issue on GitHub page with suggestions to be added.

  5. Share Altaqwaa with people you know

    • Ibn Mas'ud (RAA) narrated that the Messenger of Allah (ﷺ) said:

    “He who guides (others) to an act of goodness, will have a reward similar to that of its doer.” Related by Muslim.


Running in development mode


Basic operating requirements:

  • nodejs
  • git
  • yarn or npm

using YARN


git clone https://github.com/rn0x/Altaqwaa-Islamic-Desktop-Application

cd Altaqwaa-Islamic-Desktop-Application

yarn install

yarn run dev

using NPM


git clone https://github.com/rn0x/Altaqwaa-Islamic-Desktop-Application

cd Altaqwaa-Islamic-Desktop-Application

npm install

npm run dev

Build from source


Application will be built according to the build configuration in package.json

using YARN


#Windows
yarn run packwin

#MacOS
yarn run packmac

#Linux
yarn run packlinux

using NPM


#Windows
npm run packwin

#MacOS
npm run packmac

#Linux
npm run packlinux

Dependencies

  • adhan-js
  • electron
  • fs-extra
  • moment-js (moment-duration-format, moment-hijri, moment-timezone)
  • node-fetch
  • menubar
  • v8-compile-cache
  • nodemon for developers only

Sources


Source Link
The Noble Quran https://github.com/rn0x/Quran-Json
Translation (The Clear Quran) https://theclearquran.com
Audio Files (Noble Quran) https://www.mp3quran.net/api/_arabic.json
Supplications https://www.islambook.com/azkar
Hisnul Muslim https://www.hisnmuslim.com
Geolocation API http://ip-api.com/json
Icons https://www.flaticon.com
Noble Quran Font https://fonts.qurancomplex.gov.sa/wp02
Arabic Font https://github.com/rastikerdar/vazirmatn
Animation Effects https://animate.style

Contributors



rn0x
kemzops

Glory is to You, O Allah, and praise; I bear witness that there is none worthy of worship but You. I seek Your forgiveness and turn to You in repentance.