ramazan
v1.0.4
Published
Ramazan Sehri & Iftar times based on your location
Maintainers
Readme
cat <<'EOF' > README.md
🌙 ramazan
ramazan is a zero-configuration Node.js CLI + library that provides accurate prayer times, Ramadan fasting status, Sehri & Iftar timings, and Eid date based on the user’s current location.
It supports Sunni and Shia (Jafari) fiqh and works with offline fallbacks.
✨ Features
- 📍 Automatic location detection (IP-based)
- 🕌 Daily prayer times (Fajr → Isha)
- 🌙 Ramadan fasting day & remaining days
- 🌅 Sehri end & 🌇 Iftar time
- 🎉 Predicted Eid al-Fitr date
- 🧮 Sunni & Shia (Jafari) support
- 📴 Offline calculation fallback
- 💻 CLI + JavaScript API
📦 Installation
npm install ramazan
Or use instantly without installing:
npx ramazan
🚀 CLI Usage
Default (Sunni)
ramazan
Shia (Jafari)
ramazan --fiqh shia
📚 JavaScript API Usage
import { getRamazanInfo } from "ramazan";
const data = await getRamazanInfo();
console.log(data.prayers.maghrib);
⚙️ Options
Option Default Description
fiqh sunni sunni or shia
🛠 Requirements
Node.js v16+
Internet access
🤲 Disclaimer
Prayer times and Ramadan/Eid dates are calculated estimates.
Always follow your local mosque or authority.
📄 License
MIT
May Allah accept your fast 🤲