Awesome
<a href="https://s.id/standwithpalestine"><img alt="I stand with Palestine" src="https://cdn.jsdelivr.net/gh/Safouene1/support-palestine-banner@master/banner-project.svg" width="100%" /></a>
Dua & Dhikr
A free RESTful API server that provides Duas and Dhikr following the Sunnah of the Prophet Muhammad (peace be upon him)
بسم الله الرحمن الرحيم
Requirements
- Node.js
>= 20.x - npm
Getting Started
-
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
-
-
One-click Deployment
The fastest way to use it privately on PaaS available
<a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffitrahive%2Fdua-dhikr%2Ftree%2Fmain"> <img alt="Deploy with Vercel" src="https://vercel.com/button" height="32" /> </a> <a href="https://app.koyeb.com/deploy?type=git&repository=github.com/fitrahive/dua-dhikr&branch=main&name=dua-dhikr"> <img alt="Deploy with Koyeb" src="https://www.koyeb.com/static/images/deploy/button.svg" height="32" /> </a> <a href="https://render.com/deploy"> <img alt="Deploy with Render" src="https://render.com/images/deploy-to-render-button.svg" height="32" /> </a>Basic Usage
Base URL : http://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-Languageheader. By default, it will useid(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).
Showcase
List of awesome projects (اللّٰهُمَّ بَارِكْ) powered by this API
Ready to use!
List of server APIs ready to use publicly
Contribute
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
Columns description
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.
License
This project is licensed under MIT License.<br>