Hosted API access is disabled on `al-quran-database.vercel.app` for now. Use the repository locally or self-host this project to run the API endpoints documented here.
Canonical Data Layer

JSON-first dataset. SQL local. Exports reproducible.

The source of truth resides in sharded JSON. Conversion is deterministic, verification is hash-backed, and relational exports are regenerated from committed dataset artifacts.

Source SHA-256

fbb745997c555b3524dd1818cd2d4d9dc5fa3d2f4b24e5f5a0789bca77743e02

SQL Size

187.0 MB

Knowledge Layer

8

Curated entries

SQLite Export

7.3 MB

Portable file for local apps, edge reads, test fixtures, and offline bundles.

Download Export

PostgreSQL Export

6.5 MB

Transactional schema + data dump with foreign keys, indexes, and normalized enrichment tables.

Download Export

Normalized Schema

Core canon: surahs, ayahs, words, editions
Reading divisions: juzs, hizbs, rubs, pages + normalized join tables
Context: duas, asbab al-nuzul, hadith references, surah profiles
Knowledge layer: themes, cross references, scientific notes, fiqh notes, linguistic notes, misinterpretations, FAQs, research refs

Data Pipeline Ops

npm run data:convertnpm run data:verify -- --check-determinismnpm run data:exportnpm run data:migratenpm run data:seednpm run data:bench

Build Artifacts

Download links point at `/quran_indexed.sqlite` and `/quran_postgres.sql` from public build output.

Versioned Runtime

App traffic reads versioned API contracts under `/api/v1/*`. Database exports track same committed JSON source used by docs and SDK.

Deployment Note

Docker is intentionally out of scope in current pass. Self-host docs should assume standard Next.js deployment plus optional Redis cache.

Integrity

Deterministic pipeline ensures perfect parity between SQL and JSON distributions.

Performance

Pre-indexed SQLite exports optimized for zero-latency lookups.

Scalability

Flexible architecture supporting everything from edge read-only to full RDBMS workloads.