Quran Lab

Web quick start

The npm package for browsers and Node: the install line, where the key goes, and the quick start.

The web SDK is the engine compiled to WebAssembly, for browsers and Node 20 or later. The package is @quran-lab/tajweedformer on npm; the source is at github.com/Quran-Lab/tajweedformer-web.

Install

npm install @quran-lab/tajweedformer@2.0.2

The key

Use a web key. A web key is public by design: it works only from the exact https origins you give it, and each origin shows up as its own app. The page needs a secure context (https, or http://localhost).

# .env.local (git-ignored)
VITE_QURANLAB_KEY=qlk_v1_...

What it needs

  • A browser with WebAssembly, or Node 20 or later.
  • A secure context: https, or http://localhost. A browser gives the microphone to nothing else, and the microphone needs a tap or a click.
  • The exact origins of your pages on the web key: it works from nowhere else.
  • A connection once. The model (56.5 MB) downloads on first use, every file is verified, and it is kept by the browser for later visits.

Quick start

The quick start for this version is in the package's README: github.com/Quran-Lab/tajweedformer-web.