---
## โจ Features
| | Feature | Details |
|---|---|---|
| ๐ | **Complete Collection** | All 4,341 hadiths from Sunan Ibn Majah |
| ๐ | **Bilingual** | Full Arabic text + English translation |
| โก | **Offline-first** | Data bundled โ no CDN needed |
| ๐ง | **Zero Dependencies** | Nothing extra to install |
| ๐ | **Full-text Search** | Search English text and narrator names |
| ๐ฅ๏ธ | **CLI** | Terminal access with `-a`/`-b` Arabic flags + `--info`, `--chapters` |
| โ๏ธ | **React Hook** | One command generates `useMajah()` |
| ๐ | **Python** | Identical API โ same camelCase method names |
| ๐ | **TypeScript** | Full type definitions included |
---
## ๐ Installation
```bash
npm install sunan-ibn-majah # JS local
npm install -g sunan-ibn-majah # JS global CLI
pip install sunan-ibn-majah # Python
```
---
## ๐จ JavaScript / Node.js
```javascript
const majah = require('sunan-ibn-majah'); // CJS
import majah from 'sunan-ibn-majah'; // ESM
majah.get(1)
majah.getByChapter(1)
majah.search('prayer')
majah.search('prayer', 5)
majah.getRandom()
majah[0]
majah.length
majah.metadata
majah.chapters
```
---
## โ๏ธ React
```bash
cd my-react-app
majah --react # generates src/hooks/useMajah.js
```
```jsx
import { useMajah } from '../hooks/useMajah';
function HadithOfTheDay() {
const majah = useMajah();
if (!majah) return Loading...
;
const h = majah.getRandom();
return {h.english.narrator}{h.english.text}
;
}
```
---
## ๐ Python
```python
from sunan_ibn_majah import Majah
majah = Majah()
majah.get(1)
majah.getByChapter(1)
majah.search("prayer")
majah.search("prayer", limit=5)
majah.getRandom()
majah[0]
majah.length
majah.find(lambda h: h.id == 23)
majah.filter(lambda h: h.chapterId == 1)
majah.slice(0, 10)
# Custom path
majah = Majah(data_path="/path/to/majah.json")
```
---
## ๐ฅ๏ธ CLI
```bash
majah 1 # Hadith by ID
majah 2345 -a # Arabic only
majah 2345 -b # Arabic + English
majah 23 3 # 3rd hadith of chapter 23
majah --search "prayer"
majah --search "fasting" --all
majah --chapter 1
majah --chapters # List all chapters
majah --random
majah --info # Book metadata
majah --react
majah --version
```
---
## ๐ Structure
```
sunan-ibn-majah/
โโโ data/
โ โโโ majah.json โ source of truth
โ โโโ majah.json.gz โ generated (shipped in packages)
โ โโโ chapters/ โ generated (gitignored)
โโโ bin/index.js โ CLI
โโโ src/ โ JS source
โโโ types/index.d.ts
โโโ python/sunan_ibn_majah/ โ Python package
โโโ scripts/build.mjs
โโโ examples/
โโโ docs/
โโโ tests/
```
---
## ๐ง Development
```bash
# Place your real majah.json in data/
node scripts/build.mjs
# Test locally
python -m build --wheel
python -m zipfile -l dist\sunan_ibn_majah-1.1.0-py3-none-any.whl | findstr "majah.json.gz"
pip install dist\sunan_ibn_majah-1.1.0-py3-none-any.whl --force-reinstall
majah 23
```
Publishing is automatic via GitHub Actions on every GitHub Release.
---
## ๐ License
GNU Affero General Public License v3.0 (AGPL-3.0)
---
**Made with โค๏ธ for the Muslim community ยท Seeking knowledge together**
[](https://github.com/SENODROOM/sunan-ibn-majah/stargazers)
sunan-ibn-majah
