Getting Started
Welcome to quran-search-engine. This lightweight library empowers developers to seamlessly integrate deterministic Arabic text search for the Quran into any application environment—browser, React, Vue, Native, or a Node.js API backend.
Why this Library?
Unlike existing Quran search solutions which are tightly coupled to stateful UI components, restrictive queries, or backend API latency, quran-search-engine:
- Operates 100% agnostic of any UI layer.
- Functions statelessly (allowing for rapid deterministic query times).
- Written with a TypeScript-First methodology (all typings exported & strictly enforced).
- Combines exact match, lemma morphological match, root Arabic match, and a fallback Fuzzy match natively.
How to use these Docs
- Start by picking your package manager in the Installation Guide.
- Grab the basic setup block in Quick Start.
- If you want a deep dive into how scores are assigned across Arabic morphology, read Search Syntax.
- See live implementations like a React or Angular frontend under Examples.