Skip to content

Latest commit

 

History

History
129 lines (86 loc) · 4.25 KB

README.id.md

File metadata and controls

129 lines (86 loc) · 4.25 KB

I stand with Palestine

Doa & Dzikir

Server RESTful API gratis yang menyajikan Doa dan Dzikir sesuai Sunnah Nabi Muhammad shallallahu 'alaihi wa sallam

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

English

Persyaratan

  • Node.js >= 20.x
  • npm

Memulai

  1. Clone repositori ini

    git clone https://github.com/fitrahive/dua-dhikr.git
  2. Pindah ke direktori repositori

    cd dua-dhikr
  3. Install dependensi

    npm ci
  4. Jalankan di lokal

    • Mode pengembangan (development)

      npm run dev
    • Mode produksi

      1. Build terlebih dulu

        npm run build
      2. Jalankan aplikasi

        npm run start

One-click Deployment

Cara cepat untuk menggunakannya secara pribadi dengan PaaS yang ada

Deploy dengan Vercel Deploy dengan Koyeb Deploy dengan Render

Penggunaan

URL Utama : http://localhost:3000

Titik Akhir Deskripsi Metode
/languages Mendapatkan daftar bahasa yang di dukung GET
/categories Mendapatkan daftar kategori doa & dzikir GET
/categories/:slug Mendapatkan daftar doa & dzikir berdasarkan kategori tertentu GET
/categories/:slug/:id Mendapatkan detail doa & dzikir berdasarkan kategori dan id GET

Important

Untuk mendapatkan data dengan bahasa yang didukung, gunakan header Accept-Language. Secara bawaan akan menggunakan id (Bahasa Indonesia).

Pameran

Daftar proyek keren (اللّٰهُمَّ بَارِكْ) yang didukung oleh API ini

  • Kaaba
    Aplikasi doa & dzikir sesuai sunnah (berbasis web) oleh @sooluh

Siap digunakan!

Daftar server API yang siap digunakan secara publik

Kontribusi

Lengkapi atau tambah data Doa & Dzikir sesuai Sunnah yang kamu tahu, pastikan data tersebut shahih!

Warning

Bertakwalah kepada Allah! Kontribusimu akan dihisab kelak di akhirat!

  1. Fork repositori ini
  2. Buka data/dua-dhikr dan pilih kategori yang tersedia
  3. Buka berkas JSON pada bahasa yang diinginkan, atau tambah baru dengan kode ISO 639
  4. Lakukan perubahan dengan hati-hati!
  5. Commit perubahan dengan perintah npm run commit.
  6. Ajukan pull-request
  7. Tunggu kami melakukan merge

Deskripsi kolom

  • title berisi judul Doa/Dzikir.
  • arabic berisi Doa/Dzikir dalam tulisan arab.
  • latin berisi transliterasi dari tulisan arab ke latin.
  • translation berisi terjemahan (translasi) ke bahasa terkait.
  • notes berisi catatan (Contoh: Dibaca 3x).
  • fawaid berisi faedah/fawaid dari Doa/Dzikir terkait.
  • source berisi referensi hadits yang shahih.

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT.

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