Dua & Dhikr

A free RESTful API server that provides Duas and Dhikr following the Sunnah of the Prophet Muhammad (peace be upon him)

بسم الله الرحمن الرحيم

Bahasa Indonesia

Requirements

Node.js >= 16.20.1
Yarn >= 1.22.0

Getting Started

Clone this repository

git clone https://github.com/fitrahive/dua-dhikr.git

Move to the repository directory
```
cd dua-dhikr
```
Install dependencies
```
yarn install
```
Run locally
- Development mode
```
yarn dev
```
- Production mode
  1. Build first
```
yarn build
```
  2. Start app
```
yarn start
```

One-click Deployment

The fastest way to use it privately on PaaS available

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-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).

Showcase

List of awesome projects (اللّٰهُمَّ بَارِكْ) powered by this API

Kaaba
Authentic sunnah dua & dhikr app (web based) by @sooluh

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-dhikr and select an available category
Open the JSON file in the desired language, or add a new one with the ISO 639 code
Make changes carefully!
Commit the change using the command yarn commit.
Submit a pull-request
Wait for us to perform the merge

Note

title contains the title of the Dua/Dhikr.
arabic contains the Dua/Dhikr in Arabic script.
latin contains the transliteration from Arabic script to Latin characters.
translation contains the translation in the desired language.
notes contains notes (e.g., Recite 3x).
fawaid contains the benefits or virtues of this Dua/Dhikr.
source contains the reference to the authentic Hadith used.

License

This project is licensed under MIT License.

dua-dhikr
dua-dhikr copied to clipboard

Metadata

Dua & Dhikr

بسم الله الرحمن الرحيم

Requirements