⏰ Payer - Islamic Prayer Times PWA

A modern, responsive Prayer Times Progressive Web App with Quranic support, notifications, and offline capability.

Live Demo • Documentation • Contributing • Security Policy

---

✨ Features

• 🕌 Prayer Times - Accurate prayer times based on location (city or geolocation).
• 🔔 Smart Notifications - Get desktop/mobile audio-visual reminders for upcoming prayers.
• 📖 Quranic Content - Integrated Quranic reader with multiple translation/font settings.
• 📅 Monthly Calendar - View prayer times in the Hijri calendar.
• 🌙 Dark Mode - Clean dark mode UI with system preference detection.
• 🗣️ Multi-Language - Right-to-Left (RTL) Arabic layout and English support.
• 📱 PWA Support - Installable as a native app on mobile & desktop with offline capability.
• 🎯 Prayer Tracker - Track completed prayers daily on your local device.

---

🚀 Quick Start

To run the application locally in less than 5 minutes:

Prerequisites

• Node.js (v20.11.0 or higher) - See .nvmrc for pinned version
• npm (v10.8.2 or higher)

Steps

# 1. Clone the repository
git clone https://github.com/Mostafa-SAID7/Azan-Prayer-F.git
cd Azan-Prayer-F

# 2. Install dependencies
npm ci

# 3. Start development server
npm run dev

Open http://localhost:5173 in your browser.

For advanced setup instructions and configuration variables, see the Development Setup Guide.

---

📚 Documentation

Detailed guides are located in the docs directory:

• 🛠️ Setup Guide - Development environment setup and IDE configurations.
• ⚡ Quick Start - Fast 5-minute setup checklist.
• 🏗️ Architecture - System design, folder structure, hooks, and contexts.
• 🔌 API Reference - External integration endpoints (Aladhan and Quran).
• 🚢 Deployment - Complete deployment guide for Vercel, Netlify, GitHub Pages, and Docker.
  • 📋 Vercel Setup Guide - Step-by-step Vercel deployment with environment variables.
  • ✅ Deployment Checklist - Pre & post-deployment verification checklist.
  • 🔄 CI/CD Pipeline - GitHub Actions workflows, secrets setup, and deployment automation.
• ❓ FAQ - Frequently asked questions about calculation methods and location.
• 🛠️ Troubleshooting - Common development and production build issues.

---

🤝 Contributing

We welcome contributions! Please check our Contributing Guidelines and our Code of Conduct before submitting pull requests.

---

🔒 Privacy & Security

• Zero External Data Storage: No personal data or settings are stored on external servers.
• Local Storage: Your prayer tracker, location preferences, and favorite cities remain entirely on your local browser/device.
• Offline First: All core functionalities are cached and run offline.

Please see our Security Policy for details.

---

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ for the Muslim community