A free RESTful API server that provides Duas and Dhikr following the Sunnah of the Prophet Muhammad (peace be upon him)
- Node.js
>= 20.x - npm
-
Clone this repository
git clone https://github.com/fitrahive/dua-dhikr.git
-
Move to the repository directory
cd dua-dhikr -
Install dependencies
npm ci
-
Run locally
-
Development mode
npm run dev
-
Production mode
-
Build first
npm run build
-
Start app
npm run start
-
-
The fastest way to use it privately on PaaS available
Base URL : https://localhost:3000
| Endpoint | Description | Method |
|---|---|---|
/languages |
Retrieve a list of supported languages | GET |
/categories |
Retrieve a list of dua & dhikr categories | GET |
/categories/:slug |
Retrieve a list of dua & dhikr based on a category | GET |
/categories/:slug/:id |
Retrieve details of a dua & dhikr based on category and id | GET |
Important
To retrieve data in supported language, use the Accept-Language header. By default, it will use id (Indonesian).
Warning
Currently, only Indonesian is ready to be served! For English and other languages, translation is in progress. Please wait, or help us to translate into other languages (except English, which is currently under development).
List of awesome projects (اللّٰهُمَّ بَارِكْ) powered by this API
List of server APIs ready to use publicly
Complete or add Duas and Dhikr data according to the authentic Sunnah that you know, ensure the data is authentic!
Warning
Fear Allah! Your contributions will be accounted for in the Hereafter!
- Fork this repository
- Open
data/dua-dhikrand select an available category - Open the JSON file in the desired language, or add a new one with the
ISO 639code - Make changes carefully!
- Commit the change using the command
npm run commit. - Submit a pull-request
- Wait for us to perform the merge
titlecontains the title of the Dua/Dhikr.arabiccontains the Dua/Dhikr in Arabic script.latincontains the transliteration from Arabic script to Latin characters.translationcontains the translation in the desired language.notescontains notes (e.g., Recite 3x).fawaidcontains the benefits or virtues of this Dua/Dhikr.sourcecontains the reference to the authentic Hadith used.
This project is licensed under MIT License.