Phase 1: Intelligence & Search
- Ranked Search via FlexSearch
- Arabic Text Normalization
- Advanced Filtering System
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.
Project Roadmap
Tracking the evolution of the Quran Developer Platform. From core data engineering to AI-driven semantic exploration.
Completed
Phase 2: Developer Ecosystem
- JS/TS Developer SDK (@faha1999/al-quran-database)
- Zero-setup local data layer (getSurah, getAyah, searchAyahs offline)
- Bundled editions (en.sahih, en.yusufali, quran-uthmani, quran-simple-clean)
- jsDelivr / unpkg CDN auto-distribution
- PostgreSQL & SQLite Exports
- Sharded Data Pipeline
Phase 3: Production Readiness
- GraphQL API Layer
- Multi-Level Caching (Redis)
- Knowledge Base Integration
- Centralized Logging & Proxy
Phase 4: Advanced Scaling
- npm registry publishing — package live
- Versioned REST API (/api/v1/*)
- Legacy API aliases for backward compatibility
- Audio Recitation Streaming API (pending)
Phase 5: Growth & Distribution
- README overhaul — badges, zero-setup example, comparison table
- GitHub Sponsors via FUNDING.yml
- Code of Conduct (Contributor Covenant v2.1)
- Structured GitHub issue templates
- CHANGELOG (Keep-a-Changelog format)
- Light contribution path for docs/example PRs
Future Horizon
Beyond Phase 5, we are exploring Semantic Search (vector embeddings for meaning-based lookup), an Interactive API Playground, Docker self-hosting templates, and bundling all 134 editions as CDN-served lazy-load shards. Community contributions welcome via the issue tracker.