Skip to content

GibreelAbdullah/Hadith-Hub

Repository files navigation

ReadMeSupportPalestine

FROM THE RIVER TO THE SEA, PALESTINE WILL BE FREE

HADITH HUB (حديث حب)

With the name of Allah, the All-Merciful, the Very-Merciful.

All praise and thanks are due to Allah, the Master and King of existence, the All-Merciful, Beneficent, who has power over all things. May peace and blessings be upon His final Messenger, Sayyidina Muhammad ﷺ, and his Family, and his Companions. About

HadithHub.com started in October 2022. It aims to make it easy for anyone to read, study, and learn the ahadith of Sayyidina Rasulullah ﷺ. This project is open source.

This repo is the frontend of the hadithhub.com, the data is in the hadith-api repo. We will be grateful if you contribute in this project to make it better.

It would be a grave injustice to omit the mention of Fawaz Ahmed who made the enormous effort in collecting Ahadith in multiple languages and their gradings by multiple scholars. This project wouldn't be possible without his efforts. May Allah ﷻ reward him immensely.

Credits

Fawaz Ahmed : For collecting all the Ahadith data. A complete list of sources of the data can be found here.

Contributors - UI : Contributors who helped in creating the website.

Contributors - Data : Contributors who helped in collecting hadith/gradings or correcting them.

Svelte : A front-end, open-source JavaScript framework for making interactive webpages.

Skeleton : A fully featured UI Toolkit for svelte.

html-to-image : A javascript library to convert html to image, essentially allowing us to download screenshots of Ahadith.

Prerequisites

npm should be installed in the system.


Contribution Guide

There are 3 repositories of interest.

  1. Hadith Hub (This Repo) - It is the frontend of the application written in Svelte.

  2. hadith-api Branch name '2' - It holds all the data. All the json files in the repo act as APIs and the raw files are are served to the website whenever requested.

  3. hadith-search-api - For the search functionailty, this is deployed to a server. Currently rethinking this implementation to make it more robust and cost effective.

You may raise a PR, give suggestions, raise issues for any of them.


To run the project

  1. Clone the reposiory.

  2. run npm install to install dependencies

  3. run npm run dev to run the application in dev mode.

  4. Goto http://localhost:5173 in your browser.

About

HadithHub - A Multi Language collection of Hadith

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •