quran-json/README.md
2024-05-19 22:44:11 -03:00

2.8 KiB

About

quran-json is a dual purpose project where on the one hand it provides a command-line utility for downloading the content of The Quran in multiple languages, and on the other hand it provides a copy of the content that can be downloaded. The content is provided in the JSON format.

share/

The share/quran-json/TheQuran directory contains multiple sub-directories, where each sub-directory represents a locale (eg en for English, ar for Arabic, and so on). Within each sub-directory, there is a JSON file for each surah (also known as a chapter).

The structure of each JSON file can be described as an array where the first element is an object that contains information about a surah, and the rest of the array contains the content of the surah. The content is composed of two-element arrays - where the first element is the ayah number (also known as a verse number), and the second element is the content of the ayah.

See Surah Al-Fatihah (English) for an example.

bin/

The bin/quran-json executable is a utility for downloading the content of The Quran in multiple languages.

Usage

Usage: quran-json pull [OPTIONS]
  -l, --locale LOCALE    A locale (eg 'en')
  -r, --replace          Replace existing JSON files
  -u, --update           Update surah metadata

Thanks

Alhamdulillah

Thanks to the following websites for providing the downloadable content:

Thanks to the translators:

  • Dr. Mustafa Khattab for the English translation
  • Hussain Ansarian for the Farsi translation
  • Sofian S. Siregar for the Dutch translation
  • Muhammad Hamidullah for the French translation
  • Hamza Roberto Piccardo for the Italian translation

License

The "source code" is released under the GPL license
The translators hold the copyright for the translated content