Al-Quran Reminder Extension
A Visual Studio Code extension that displays Al-Quran verses with Arabic text and translation as gentle pop-up reminders to help you stay connected with Islamic teachings during your coding sessions.
Features
- 📿 Pop-up Reminders: Get beautiful Al-Quran verse reminders while coding
- 🌙 Arabic & Translation: Display verses in both Arabic text and English translation
- ⏰ Customizable Intervals: Set reminder frequency in seconds, minutes, or hours
- 🎲 Flexible Display Modes: Choose between sequential or random verse selection
- ⚙️ Rich Configuration: Extensive settings to customize your experience
- 📋 Easy Copy: Copy verses to clipboard with one click
- 🎨 Beautiful UI: Clean, VS Code-themed webview for detailed verse display
- 🔄 Persistent State: Remembers your progress through verses
- ⚡ Background Service: Efficient reminder management
Screenshots
The extension provides gentle notification popups with verses, and detailed webview panels for full verse exploration.
Installation
From VS Code Marketplace
- Open VS Code
- Go to Extensions view (Ctrl+Shift+X)
- Search for "Al-Quran Reminder"
- Click Install
Manual Installation
- Download the latest
.vsix file from GitHub Releases
- Open VS Code
- Go to Extensions view (Ctrl+Shift+X)
- Click on the "..." menu
- Select "Install from VSIX..."
- Choose the downloaded
.vsix file
Usage
Commands
Open the Command Palette (Ctrl+Shift+P) and use these commands:
Al-Quran: Start Reminders - Begin showing verse remindersAl-Quran: Stop Reminders - Stop all remindersAl-Quran: Pause Reminders - Temporarily pause remindersAl-Quran: Show Current Verse - Display a verse immediatelyAl-Quran: Open Settings - Open extension settingsAl-Quran: Debug Settings - View current configuration (for troubleshooting)
Configuration
Access settings via File > Preferences > Settings, then search for "Al-Quran Reminder":
| Setting |
Description |
Default |
alquranReminder.enabled |
Enable verse reminders |
true |
alquranReminder.autoStart |
Auto-start when VS Code opens |
true |
alquranReminder.interval |
Reminder interval (1-1440) |
30 |
alquranReminder.timeUnit |
Time unit (seconds/minutes/hours) |
minutes |
alquranReminder.displayMode |
Verse selection (sequential/random) |
sequential |
alquranReminder.showArabic |
Show Arabic text |
true |
alquranReminder.showTranslation |
Show English translation |
true |
Verse Collection
The extentions include all surah in the quran
Each verse includes authentic Arabic text with clear English or Indonesian translations to enhance understanding and reflection.
Development
Prerequisites
- Node.js (v14 or higher)
- VS Code
Building
npm install
npm run compile
Testing
npm test
Debugging
- Open the project in VS Code
- Press F5 to launch Extension Development Host
- Test the extension in the new VS Code window
Contributing
Contributions are welcome! Please feel free to:
- 🐛 Submit bug reports or feature requests via GitHub Issues
- 📖 Add more verses to the collection
- 🌍 Improve or add translations in other languages
- 🎨 Enhance UI/UX design
- 📝 Improve documentation
- 🧪 Add tests and improve code quality
Development Setup
- Clone the repository
- Run
npm install to install dependencies
- Open in VS Code and press F5 to launch Extension Development Host
- Make changes and test in the new VS Code window
Release Notes
1.0.9 (Latest)
- Enhanced verse collection with over 100 verses
- Improved webview display and typography
- Better state management and persistence
- Performance optimizations
- Bug fixes and stability improvements
1.0.0
Initial release of Al-Quran Reminder extension:
- Basic verse reminder functionality
- Configurable timing intervals
- Sequential and random display modes
- Arabic text and translation support
- Rich webview for detailed verse display
- Copy to clipboard functionality
- Command palette integration
- Persistent state management
For complete changelog, see CHANGELOG.md.
Support
If you encounter any issues or have suggestions:
- 📧 File an issue on GitHub
- 🌟 Star the repository if you find it helpful
- 🔄 Share with fellow Muslim developers
Acknowledgments
- All praise and thanks to Allah (SWT)
- Translations sourced from authentic Islamic sources
- Built with love for the Muslim developer community
License
This project is licensed under the MIT License - see the LICENSE file for details.
May Allah bless your coding journey! 🤲
"And whoever relies upon Allah - then He is sufficient for him. Indeed, Allah will accomplish His purpose." - Quran 65:3
"And it is He who created the heavens and earth in truth. And the day He says, 'Be,' and it is, His word is the truth." - Quran 6:73
