Skip to content

YemenOpenSource/athkari

 
 

Repository files navigation

🌿 Athkari – Islamic Reminders for VS Code

Athkari is a lightweight VS Code extension that displays Islamic Athkar (remembrances of Allah) while you code, helping you stay spiritually connected throughout your workday.


✨ Features

  • 🕌 Shows "بسم الله الرحمن الرحيم" on startup
  • 🔔 Sends a random Thikr notification every 30 minutes (customizable)
  • Add new Athkar to your personal list
  • ✏️ Edit any existing Thikr
  • 🗑️ Delete Athkar you no longer need
  • ⏱️ Change the reminder interval to any number of minutes
  • 🔄 Refresh to restart reminders and see the welcome message again
  • 💾 All changes are saved persistently across sessions

How to Install

  1. Open Visual Studio Code.
  2. Go to extensions.
  3. Search for 'Athkari'.
  4. Click on Install.
  5. Reload VS Code

🛠 How to Use

Open the Command Palette:

Ctrl + Shift + P

Type athkari and press Enter. A menu will appear with the following options:


➕ Add a New Thikr

  1. Select "إضافة ذكر جديد" from the menu
  2. Type the new Thikr text in the input box
  3. Press Enter to save it

The new Thikr will be added to your list and may appear in future reminders.


✏️ Edit an Existing Thikr

  1. Select "تعديل ذكر" from the menu
  2. A list of all your current Athkar will appear — pick the one you want to edit
  3. The selected text will appear in an input box — modify it as needed
  4. Press Enter to save the updated text

🗑️ Delete a Thikr

  1. Select "حذف ذكر" from the menu
  2. A list of all your current Athkar will appear — pick the one you want to delete
  3. A confirmation prompt will ask "نعم" (Yes) or "لا" (No)
  4. Select "نعم" to confirm deletion

⏱️ Change Reminder Interval

  1. Select "تعديل الوقت" from the menu
  2. Enter the number of minutes between reminders (e.g., 15 for every 15 minutes)
  3. Press Enter to apply

The new interval is saved and will persist across VS Code restarts.


🔄 Refresh

  1. Select "تحديث" from the menu
  2. The extension will show a welcome message confirming the refresh

❤️ Contributing

Contributions, suggestions, and improvements are always welcome!


Made by Ammar Almansouri to help developers remember Allah while coding.

About

My Extension in vs code ..

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 92.6%
  • JavaScript 7.4%