README.md

Simple Prayertime Reminder - A simple muslim prayertime reminder app for desktop

A simple muslim prayertime reminder app for desktop. Made using Electron with electron-react-boilerplate. UI are made using Material UI.

---

Table of Contents

• Table of Contents
• FAQ
• Features
• Showcase
• Download
• Installation
• Uninstallation
• Customization
• Developing
  • Starting Development
  • Packaging for Production
  • Further Instructions
  • Electron React Boilerplate Docs
  • License
• Attribution
• Further help

---

FAQ

1. Q: Compatible platform?
   A: This app can be used on Windows and Linux. It should also work on MacOS but unfortunately, I haven't tested it.
2. Q: What is this app for?
   A: This app works just like any other prayer time/reminder app, it shows prayer time schedule for a specific location/date and the reminder for it.
3. Q: How do i get help for the user settings?
   A: You can check out the wiki on this section.
4. Q: My location is incorrect help
   A: You can set the location manually in the settings. For more info check on the options section of the wiki.
5. Q: Does this work offline?
   A: Yes, the app works offline, internet connection is only needed for location detecting (there is also an offline method if an internet connection is not present) and version checking.

Features

• Prayer times with customizable reminder/notification
• Prayer times schedule (calendar)
• Export prayer times schedule
• Adhan
• Qibla direction

Showcase

This app is quite modern looking because of Material UI, it also have dark and light theme.

Preview

Download

• Latest release
• Sourceforge

Installation

1. Download the latest release from GitHub
2. Extract/Install
3. Run the program

Uninstallation

Run the uninstaller if you are using the installer version. If using the portable version, you can just delete the folder. On windows, there might be a registry left behind that you can delete if want to by going to regedit and delete the Simple PrayerTime Reminder registry on \HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Run.

Customization

Check the wiki for more information.

Developing

This app is developed using Electron React Boilerplate. It uses Electron, React, React Router, Webpack and React Fast Refresh.

Starting Development

Install all the packages:

npm install

Start the app in the dev environment:

npm start

Packaging for Production

To package apps for the local platform:

npm run package

This will compile the app into the release folder.

To compile the app into a certain architecture/platform, you can add extra options to the package command, ex:

npm run package --win --ia32

# If npm does not work, try to use yarn
yarn package --win --ia32

For commands list you can check in the official electron builder website

Further Instructions

You can check this repo's wiki or You can ask in discussions

Electron React Boilerplate Docs

See Electron React Boilerplate docs and guides here

License

MIT © Dadangdut33 and MIT © Electron React Boilerplate

Attribution

Adhan uploaded by Ayat Via Youtube

Mosque icons created by Freepik - Flaticon

Further help

• Check the Wiki
• Submit an Issue
• Ask in Discussion