quran-quiz
v0.1.4
Published
A quiz game for the Quran
Downloads
6
Readme
Quran Quiz
quran-quiz
is a library for generating quizzes about the Quran. This library is designed to enhance Quranic memorization.
Read the docs at quran.zakiego.com.
Features
- [x] Guess Verse by Surah
- [x] Guess Verse by Juz
- [x] Guess Surah by Surah
- [ ] Guess Surah by Juz
Installation
npm install quran-quiz
Example
Request
import { guessSurah } from "quran-quiz";
const data = await guessSurah.bySurah({
amount: 3,
select: [111, 112, 113, 114],
});
Response
When the options.value
is set to 1, it means the answer is correct, while when the options.value
is set to 0, it means the answer is incorrect.
{
"data": [
{
"question": " قُلْ هُوَ ٱللَّهُ أَحَدٌ",
"options": [
{
"text": "Al-Masad",
"value": 0
},
{
"text": "Al-Falaq",
"value": 0
},
{
"text": "An-Nas",
"value": 0
},
{
"text": "Al-Ikhlas",
"value": 1
}
]
}
// ...
],
"meta": {
"type": "guessSurahBySurah",
"select": [111, 112, 113, 114],
"amount": 3
}
}