Islam Suite (Salah, Qibla, Hijri) — Developer Guide & Admin UI
1. Installation & Peer Setup
Section titled “1. Installation & Peer Setup”pnpm add @vicacha-devs/strapi-plugin-islam2. Server Configuration (config/plugins.ts)
Section titled “2. Server Configuration (config/plugins.ts)”Add the plugin configuration to your Strapi v5 config/plugins.ts file:
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({ "islam": { enabled: true, config: { defaultLat: 4.6685, defaultLon: -74.0758, method: "3", quranFoundation: { defaultScript: "uthmani", defaultReciterId: 7, // Mishari Rashid al-`Afasy defaultChapterReciterId: 7, // Mishari Rashid al-`Afasy }, enableInboxAlertBridge: true, }, },});
3. Strapi v5 Admin UI Tour
Section titled “3. Strapi v5 Admin UI Tour”Once enabled, the plugin registers its workspace and settings inside the Strapi v5 Admin panel using Strapi Design System v2 components:

Key Localized Admin UI Labels
Section titled “Key Localized Admin UI Labels”| Translation Key | Rendered UI Label |
|---|---|
page.ui.islam_liturgical_scriptural_fiqh_cockpit |
Islam Liturgical, Scriptural & Fiqh Cockpit |
page.ui.1_salah_adhan_iqamah |
Salah, Adhan & Iqamah |
page.ui.2_hilal_ramadan_eid |
Hilal, Ramadan & Eid |
page.ui.3_quran_hadith_dua |
Quran, Hadith & Dua |
page.ui.4_zakat_nisab_qibla |
Zakat, Nisab & Qibla |
page.ui.refresh |
Refresh |
page.ui.prayer_salah |
Prayer (Salah) |
page.ui.adhan_time |
Adhan Time |
4. Content-Type Entities, Locations & Schemas (strapi.documents)
Section titled “4. Content-Type Entities, Locations & Schemas (strapi.documents)”Registers two Collection Types (plugin::islam.hilal-announcement and plugin::islam.scripture-entry) paired with pure astronomical calculation engines (prayerEngine, qiblaEngine, hijriEngine, zakatEngine, inheritanceEngine).
Where to Find Content-Type Entities in Strapi v5
Section titled “Where to Find Content-Type Entities in Strapi v5”- Content Manager:
/admin/content-manager/collection-types/plugin::islam.hilal-announcement&/admin/content-manager/collection-types/plugin::islam.scripture-entry(visible: true) - Content-Type Builder:
/admin/plugins/content-type-builderunder Collection Types (Islam Hilal Moon-Sighting Announcement&Islam Scripture & Dua Entry) - Plugin Workspace & Settings:
/admin/plugins/islam(Salah & Iqamah, Hilal Sighting, Scripture Hub, Zakat & Mirath) and/admin/settings/islam - Database Tables:
islam_hilal_announcementsandislam_scripture_entries
plugin::islam.hilal-announcement — Islam Hilal Moon-Sighting Announcement
Section titled “plugin::islam.hilal-announcement — Islam Hilal Moon-Sighting Announcement”Official Mosque Hilal Moon-Sighting confirmations for Ramadan, Eid al-Fitr, and Dhu al-Hijjah
Kind:
collectionType· DB Table:islam_hilal_announcements· Admin Location:/admin/content-manager/collection-types/plugin::islam.hilal-announcement· Draft & Publish:No· i18n:No
| Attribute | Strapi Type | Required | Constraints / Target |
|---|---|---|---|
occasion |
enumeration |
Yes | enum: ramadan, eid_al_fitr, dhul_hijjah_eid_al_adha, monthly_hilal; default: "ramadan" |
hijriYear |
integer |
Yes | — |
hijriMonth |
integer |
Yes | — |
confirmedGregorianDate |
string |
Yes | — |
shiftingApplied |
string |
No | default: "0" |
approvedByImam |
string |
No | — |
notes |
json |
No | — |
broadcastDispatched |
boolean |
No | default: false |
plugin::islam.scripture-entry — Islam Scripture & Dua Entry
Section titled “plugin::islam.scripture-entry — Islam Scripture & Dua Entry”Custom curated Quranic Ayah, Prophetic Hadith, or Hisnul Muslim Dua/Adhkar entry
Kind:
collectionType· DB Table:islam_scripture_entries· Admin Location:/admin/content-manager/collection-types/plugin::islam.scripture-entry· Draft & Publish:No· i18n:No
| Attribute | Strapi Type | Required | Constraints / Target |
|---|---|---|---|
entryKind |
enumeration |
Yes | enum: ayah, hadith, dua; default: "dua" |
slug |
string |
Yes | — |
referenceKey |
string |
Yes | — |
arabicText |
text |
Yes | — |
transliteration |
text |
No | — |
translations |
json |
Yes | — |
reflections |
json |
No | — |
gradingOrCategory |
string |
No | — |
recommendedRepetitions |
integer |
No | default: 1 |
audioUrl |
string |
No | — |
topicTags |
json |
No | — |
active |
boolean |
No | default: true |
Strapi v5 Content Manager Integration (/admin/content-manager)
Section titled “Strapi v5 Content Manager Integration (/admin/content-manager)”Content Manager Sidebar Group:
Islam, Liturgy & Scripture
Content Manager Entities & Components
Section titled “Content Manager Entities & Components”plugin::islam.scripture-entry(Islam Scripture & Dua Entry —/admin/content-manager/collection-types/plugin::islam.scripture-entry)plugin::islam.hilal-announcement(Islam Hilal Moon-Sighting Announcement —/admin/content-manager/collection-types/plugin::islam.hilal-announcement)

Why This Plugin Creates & Integrates Content Manager Entities
Section titled “Why This Plugin Creates & Integrates Content Manager Entities”@vicacha-devs/strapi-plugin-islam pairs its astronomical calculation engines (Salah, Qibla, Hijri, Zakat, Mirath) with two visible Content Manager collection types—Islam Scripture & Dua Entry (plugin::islam.scripture-entry) and Islam Hilal Moon-Sighting Announcement (plugin::islam.hilal-announcement)—so scholars and editors can curate verified religious texts and moon-sighting records with full editorial governance:
- Verified Arabic Scripture, Transliteration & Multilingual Translations: Curate Quran
ayah,hadith, andduarecords inplugin::islam.scripture-entrywith vocalizedarabicText,transliteration,translations(es,en,ar,tr),reference(Quran 2:255,Sahih al-Bukhari 1), and audio recitation URLs. - Historical Hilal Moon-Sighting Ledger: Maintain an auditable archive of official Ramadan, Shawwal (Eid al-Fitr), and Dhu al-Hijjah crescent confirmations in
plugin::islam.hilal-announcement(hijriYear,hijriMonth,dayOffset,gregorianStartDate,authority). - Scholar Review with Editorial Notes: Scholars can review Arabic diacritics and translations directly inside Content Manager and leave verification notes via
@vicacha-devs/strapi-plugin-notes.
How to Use in Strapi Content Manager (Step-by-Step)
Section titled “How to Use in Strapi Content Manager (Step-by-Step)”- Open in Content Manager: In the left sidebar, expand Content Manager -> Collection Types -> Islam, Liturgy & Scripture and select Islam Scripture & Dua Entry (
/admin/content-manager/collection-types/plugin::islam.scripture-entry?plugins[i18n][locale]=en) or Islam Hilal Moon-Sighting Announcement (/admin/content-manager/collection-types/plugin::islam.hilal-announcement). - Curate Quran, Hadith & Dua Entries: Click + Create new entry in Islam Scripture & Dua Entry, choose
entryKind(ayah,hadith,dua), enterarabicText,transliteration,reference,category, and localizedtranslations, and togglefeaturedDaily. - Inspect or Edit Hilal Announcements: Open Islam Hilal Moon-Sighting Announcement to review or update official moon-sighting declarations and their lunar
dayOffset(-2to+2). - Workspace vs. Content Manager: Use Content Manager for bulk scripture curation, citation filtering, and scholar review; use the Islam Suite Workspace (
/admin/plugins/islam) for live astronomical Salah/Iqamah timetables, 1-click Hilal confirmation + Inbox alert bridging, and Zakat/Mirath calculators.
Content Manager & Plugin Workspace Synchronization
Section titled “Content Manager & Plugin Workspace Synchronization”Content Manager Use Cases & Editorial Workflows
Section titled “Content Manager Use Cases & Editorial Workflows”Content Manager Use Case 1 — Curating the Daily Ayah, Hadith & Hisnul Muslim Supplication Library
Section titled “Content Manager Use Case 1 — Curating the Daily Ayah, Hadith & Hisnul Muslim Supplication Library”- Why & What it is for: Manage verified Arabic scripture entries (
Ayat al-Kursi,Sahih al-Bukhari 1, mosque etiquette duas) with English, Spanish, and Turkish translations in Content Manager. - How to use in Content Manager: Open
/admin/content-manager/collection-types/plugin::islam.scripture-entry?plugins[i18n][locale]=en, filter byentryKind = duaorfeaturedDaily = true, and edit the entry.
Content Manager Use Case 2 — Auditing Historical Hilal Moon-Sighting Confirmations
Section titled “Content Manager Use Case 2 — Auditing Historical Hilal Moon-Sighting Confirmations”- Why & What it is for: Maintain the institutional archive of Ramadan and Eid moon-sighting resolutions across Hijri years (
1446 AH,1447 AH). - How to use in Content Manager: Open
/admin/content-manager/collection-types/plugin::islam.hilal-announcementto inspecthijriYear,hijriMonthName,dayOffset, andauthority.
5. End-to-End Use Cases & Workflows
Section titled “5. End-to-End Use Cases & Workflows”Use Case 1 — Daily & Monthly Astronomical Salah, Adhan & Iqamah Timetables
Section titled “Use Case 1 — Daily & Monthly Astronomical Salah, Adhan & Iqamah Timetables”- What it is for: Serve accurate Fajr, Sunrise, Dhuhr, Asr, Maghrib, Isha, and Jumu’ah Iqamah schedules with high-latitude and Ramadan Imsak/Iftar rules.
- How it works: Configure coordinates,
calculationMethod(MWL,UmmAlQura,ISNA, etc.), and Iqamah offsets in/admin/settings/islam; queryGET /api/islam/prayers/todayorGET /api/islam/prayers/monthly.

Use Case 2 — Official Hilal Moon-Sighting Confirmation & Cross-Plugin Sync
Section titled “Use Case 2 — Official Hilal Moon-Sighting Confirmation & Cross-Plugin Sync”- What it is for: Record official local/regional crescent moon sightings for Ramadan, Eid al-Fitr, and Dhu al-Hijjah and immediately adjust Hijri dates across the platform.
- How it works:
POST /islam/hilal/confirmcreates aplugin::islam.hilal-announcementrecord, updates the Umm al-Qurashiftingoffset (-2to+2), and optionally publishes aplugin::inbox.alert-banner.

Use Case 3 — Curated Multilingual Quran Ayah, Hadith & Hisnul Muslim Dua Hub
Section titled “Use Case 3 — Curated Multilingual Quran Ayah, Hadith & Hisnul Muslim Dua Hub”- What it is for: Manage verified Arabic scripture entries (
entryKind: 'ayah' | 'hadith' | 'dua') with transliteration, translations (es,en,ar,tr), audio recitations (defaulting toMishari Rashid al-\Afasy, ID7`), and daily rotation. - How it works: Store records in
plugin::islam.scripture-entryand serve them viaGET /api/islam/scripture/daily,GET /api/islam/scripture/duas, andGET /api/islam/quran/resources.

Use Case 4 — Qibla Great-Circle Compass, Zakat Nisab & Faraid Inheritance Calculators
Section titled “Use Case 4 — Qibla Great-Circle Compass, Zakat Nisab & Faraid Inheritance Calculators”- What it is for: Provide interactive liturgical and Fiqh utilities via stateless REST endpoints.
- How it works: Call
GET /api/islam/qibla?lat=...&lng=...,POST /api/islam/zakat/calculate, andPOST /api/islam/inheritance/calculate.
6. REST API Endpoints (content-api & admin)
Section titled “6. REST API Endpoints (content-api & admin)”| Method | Endpoint Path | Scope | Controller Handler | Auth |
|---|---|---|---|---|
GET |
/islam/overview |
admin |
admin.getOverview |
Bearer JWT |
GET |
/islam/settings |
admin |
admin.getSettings |
Bearer JWT |
PUT |
/islam/settings |
admin |
admin.updateSettings |
Bearer JWT |
POST |
/islam/hilal/confirm |
admin |
admin.confirmHilal |
Bearer JWT |
POST |
/islam/scripture/pins |
admin |
admin.updateDailyPins |
Bearer JWT |
GET |
/api/islam/prayer-times |
content-api |
content-api.getPrayerTimes |
Bearer JWT |
GET |
/api/islam/prayer-times/monthly |
content-api |
content-api.getMonthlyPrayerTimes |
Bearer JWT |
GET |
/api/islam/prayer-times/calendar.ics |
content-api |
content-api.getPrayerCalendarIcs |
Bearer JWT |
GET |
/api/islam/qibla |
content-api |
content-api.getQibla |
Bearer JWT |
GET |
/api/islam/hijri |
content-api |
content-api.getHijriAndObservances |
Bearer JWT |
GET |
/api/islam/hijri/convert |
content-api |
content-api.convertDate |
Bearer JWT |
GET |
/api/islam/scripture |
content-api |
content-api.getScriptureHub |
Bearer JWT |
GET |
/api/islam/scripture/daily |
content-api |
content-api.getDailyInspiration |
Bearer JWT |
GET |
/api/islam/daily-inspiration |
content-api |
content-api.getDailyInspiration |
Bearer JWT |
GET |
/api/islam/quran/chapters |
content-api |
content-api.getQuranChapters |
Bearer JWT |
GET |
/api/islam/quran/chapters/{chapterNumber} |
content-api |
content-api.getQuranChapterVerses |
Bearer JWT |
GET |
/api/islam/quran/chapters/{chapterNumber}/info |
content-api |
content-api.getQuranChapterInfo |
Bearer JWT |
GET |
/api/islam/quran/chapters/{chapterNumber}/audio |
content-api |
content-api.getQuranChapterAudio |
Bearer JWT |
GET |
/api/islam/quran/verses/{verseKey} |
content-api |
content-api.getQuranVerseByKey |
Bearer JWT |
GET |
/api/islam/quran/verses/{verseKey}/hadiths |
content-api |
content-api.getQuranAyahHadiths |
Bearer JWT |
GET |
/api/islam/quran/resources |
content-api |
content-api.getQuranResources |
Bearer JWT |
GET |
/api/islam/nisab |
content-api |
content-api.getNisab |
Bearer JWT |
POST |
/api/islam/zakat/calculate |
content-api |
content-api.calculateZakat |
Bearer JWT |
POST |
/api/islam/fitrana-fidyah/calculate |
content-api |
content-api.calculateFitranaFidyah |
Bearer JWT |
7. Programmatic Server Usage (strapi.plugin & strapi.documents)
Section titled “7. Programmatic Server Usage (strapi.plugin & strapi.documents)”// Registered services on plugin "islam": "settings", "islamService"const pluginService = strapi.plugin("islam")?.service("islamService");
// Querying records via the Strapi v5 Document Service APIconst records = await strapi.documents("plugin::islam.hilal-announcement").findMany({ limit: 25, sort: "createdAt:desc",});8. Troubleshooting & Verification
Section titled “8. Troubleshooting & Verification”- Admin panel changes not visible: Run
pnpm strapi buildafter modifyingconfig/plugins.ts. - Peer dependency isolation: Keep
hoistPattern: ["*", "!@strapi/*"]inpnpm-workspace.yamlso@strapi/*contexts are never duplicated. - TypeScript type-checking: Validate both
admin/tsconfig.jsonandserver/tsconfig.jsonviapnpm --filter <pkg> test:ts.