https://github.com/gadingnst/hadith-api

Simple Islamic Hadith API with Indonesia Translation.
https://github.com/gadingnst/hadith-api

express free-api hacktoberfest hacktoberfest2022 hadith hadith-api hadith-books hadith-db hadiths islamic-app rest-api typescript

Last synced: 18 days ago
JSON representation

Simple Islamic Hadith API with Indonesia Translation.

• Host: GitHub
• URL: https://github.com/gadingnst/hadith-api
• Owner: gadingnst
• License: mit
• Created: 2020-09-02T02:46:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T01:55:59.000Z (over 1 year ago)
• Last Synced: 2024-11-14T04:05:17.157Z (28 days ago)
• Topics: express, free-api, hacktoberfest, hacktoberfest2022, hadith, hadith-api, hadith-books, hadith-db, hadiths, islamic-app, rest-api, typescript
• Language: TypeScript
• Homepage: https://api.hadith.gading.dev
• Size: 19.8 MB
• Stars: 322
• Watchers: 2
• Forks: 84
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-made-by-indonesian - Hadith - API - `Simple Islamic Hadith API with Indonesia Translation.` *by [Gading Nasution](https://github.com/gadingnst)* (H)
• made-in-indonesia - Hadith - API - `Simple Islamic Hadith API with Indonesia Translation.` *by [Gading Nasution](https://github.com/gadingnst)* (H)

README

        
# Hadith - API

> Simple Islamic Hadith API with Indonesia Translation.

### Deploy

Already deployed in [https://api.hadith.gading.dev] or you can deploy your own at:

[![Deploy your own with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%gadingnst%hadith-api)

### Data Source

- [x] [tafsirq.com](https://tafsirq.com/hadits)

- [ ] Your contribution ?

### Available Hadith

- [x] Muslim

- [x] Bukhari

- [x] Tirmidzi

- [x] Nasai

- [x] Abu Daud

- [x] Ibnu Majah

- [x] Ahmad

- [x] Darimi

- [x] Malik

- [ ] Your contribution ?

### Features

- [x] Arabic 

- [x] Indonesia Translation

- [ ] Your contribution ?

### Endpoint usage

- [x] `/books` = Returns the list of available Hadith Books.

- [x] `/books/{name}?range={number}-{number}` = Returns hadiths by range of number. **Example: [/books/bukhari?range=300-500](https://api.hadith.gading.dev/books/bukhari?range=300-500)**. *(Note: For performance reasons, max accepted range: 300)*

- [x] `/books/{name}/{number}` = Returns spesific hadith. **Example: [/books/muslim/5](https://api.hadith.gading.dev/books/muslim/5)**

### Example Response

> Fetching on [HR. Muslim No. 5](https://api.hadith.gading.dev/books/muslim/5)

[![`/books/muslim/5`](https://raw.githubusercontent.com/gadingnst/hadith-api/master/screenshots/example-result.png)](https://raw.githubusercontent.com/gadingnst/hadith-api/master/screenshots/example-result.png)

### Recommended Arabic Fonts 

- [quran.musil.com](http://quran.mursil.com/Web-Print-Publishing-Quran-Text-Graphics-Fonts-and-Downloads/fonts-optimized-for-quran)

- [Uthmani](https://groups.google.com/forum/#!topic/colteachers/Y6iKganK0tQ)

### Available Commands

- `yarn start` = run server.

- `yarn dev` = run develop server.

- `yarn crawl` = collect new data from the data source, then unifying it in one JSON file.

### LICENSE

MIT

## Support or Donate Me

### Global

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B71P7PB)

### Indonesia

- Bank Syariah Mandiri [REK: 7142365973 (SUTAN GADING F NASUTION)]

- [Trakteer](https://trakteer.id/gadingnst)

- [Karyakarsa](https://karyakarsa.com/gadingnst)

---

Copyright © 2020 by Sutan Gading Fadhillah Nasution