Quran Reminder VS Code Extension

A VS Code extension that displays Quran pages at regular intervals (default: every 30 minutes) within a user-defined time range, with progress tracking.

Features

• 📖 Quran Page Reminder: Shows a Quran page at configurable intervals (15/30/45/60 minutes)
• ⏰ Time Range: Only active during specified hours (e.g., 09:00 - 22:00)
• 📊 Progress Tracking: Tracks your reading progress (current page out of 604)
• 🎨 Status Bar: Shows current page and time until next reminder
• 🌐 API Integration: Fetches Quran data from reliable APIs (Al-Quran Cloud, Quran.com)
• 💾 Offline Support: Falls back to cached/local data when offline
• 🎯 Commands: Start/stop reminders, open Quran now, reset progress, pause for today

Installation

1. Clone this repository
2. Run npm install in the extension directory
3. Press F5 to open a new VS Code window with the extension loaded

Configuration

Add these settings to your VS Code settings.json:

{
  "quranReminder.enabled": true,
  "quranReminder.intervalMinutes": 30,
  "quranReminder.startTime": "09:00",
  "quranReminder.endTime": "22:00",
  "quranReminder.pagesPerSession": 1,
  "quranReminder.darkMode": true,
  "quranReminder.apiProvider": "alquran-cloud",
  "quranReminder.edition": "quran-uthmani"
}

Settings

• quranReminder.enabled: Enable/disable the extension (default: true)
• quranReminder.intervalMinutes: Reminder interval in minutes - 15, 30, 45, or 60 (default: 30)
• quranReminder.startTime: Start time in 24-hour format (default: "09:00")
• quranReminder.endTime: End time in 24-hour format (default: "22:00")
• quranReminder.pagesPerSession: Number of pages per reminder (default: 1)
• quranReminder.darkMode: Use dark theme for Quran view (default: true)
• quranReminder.apiProvider: API provider - alquran-cloud, quran-com, or local (default: "alquran-cloud")
• quranReminder.edition: Quran text edition for alquran-cloud API (default: "quran-uthmani")

Commands

Access via Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

• Quran Reminder: Start Reminder - Start the reminder service
• Quran Reminder: Stop Reminder - Stop the reminder service
• Quran Reminder: Open Quran Now - Open current Quran page immediately
• Quran Reminder: Reset Progress - Reset progress to page 1
• Quran Reminder: Pause for Today - Pause reminders until next day

Status Bar

The status bar shows:

• Current page number (e.g., 📖 صفحة 120 / 604)
• Time until next reminder (e.g., ⏰ 15:30)

Click the status bar item to open the Quran page immediately.

How It Works

1. The extension checks if the current time is within your specified time range
2. If within range, it schedules reminders based on your interval setting
3. When a reminder triggers, it fetches the current page from the API
4. The page is displayed in a WebView panel inside VS Code
5. Progress is automatically saved and incremented
6. Outside the time range, reminders are paused until the next day's start time

API Providers

Al-Quran Cloud (Recommended)

• Base URL: https://api.alquran.cloud/v1
• No API key required
• Supports multiple editions (quran-uthmani, quran-simple, etc.)

Quran.com

• Base URL: https://api.quran.com/api/v4
• Fallback provider
• Includes translations and tafsir references

Local

• Uses local JSON file (src/data/quran_pages.json)
• Requires manual data population for offline use

Development

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Watch for changes
npm run watch

License

MIT

Author

Ahmed Algzery