Skip to content

Latest commit

 

History

History
132 lines (88 loc) · 4.43 KB

README.md

File metadata and controls

132 lines (88 loc) · 4.43 KB
Raw

I stand with Palestine

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 >= 20.x
  • npm

Getting Started

  1. Clone this repository

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

  2. Move to the repository directory

    cd dua-dhikr

  3. Install dependencies

    npm ci

  4. Run locally

    • Development mode

      npm run dev

    • Production mode

      1. Build first

        npm run build

      2. Start app

        npm run start

One-click Deployment

The fastest way to use it privately on PaaS available

Deploy with Vercel Deploy with Koyeb Deploy with Render

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!

  1. Fork this repository
  2. Open data/dua-dhikr and select an available category
  3. Open the JSON file in the desired language, or add a new one with the ISO 639 code
  4. Make changes carefully!
  5. Commit the change using the command npm run commit.
  6. Submit a pull-request
  7. Wait for us to perform the merge

Columns description

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

جزاكما الله خيرا كثيرا