ReflectsLight/quran-json
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
The Noble Quran in its original Arabic, alongside translations
170 commits 1 branch 0 tags 8 MiB
Find a file
0x1eef 3f1ed58432 Add Pull.cli_options 
I came across the pattern in this diff while browsing the
[rake](https://github.com/ruby/rake/)
source code, and I thought it was worth repeating in quran-json.
2023-03-14 19:17:35 -03:00
bin Address rubocop errors 2023-02-13 13:23:51 -03:00
lib/quran-json/quran Add Pull.cli_options 2023-03-14 19:17:35 -03:00
libexec/quran-json Address rubocop errors 2023-02-13 13:23:51 -03:00
share/quran-json Replace Cmd#count / count.json with Cmd#metadata 2023-02-13 12:56:01 -03:00
.gitignore Add -o, --overwrite option 2023-02-09 06:40:36 -03:00
.rubocop.yml Address rubocop errors 2023-02-13 13:23:51 -03:00
.ruby-version ruby-version: 3.1.0 -> 3.2.0 2023-02-04 16:13:55 -03:00
.sqliterc add sample .sqliterc file. 2022-06-11 17:45:14 -03:00
Gemfile The great rewrite 2023-02-08 16:14:48 -03:00
Gemfile.lock Gemfile.lock: update 2023-03-14 19:10:59 -03:00
LICENSE License = GPL 2023-03-11 12:22:16 -03:00
README.md Add Pull.cli_options 2023-03-14 19:17:35 -03:00
VERSION v0.11.1 2022-12-26 02:56:03 -03:00

README.md

About

quran-json is a dual purpose project where on the one hand it provides a 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    ar, en, pt, fa, nl, fr, or it (default: en)
  -r, --replace          Replace existing JSON files (default: no)
  -u, --update           Replace surah metadata with an updated copy (implies -r, default: no)

Thanks

First and foremost, Alhamdulillah.

Thanks to the following websites for providing the downloadable content:

And sincere thanks to the translators of the content:

  • Dr. Mustafa Khattab for the English translation.
  • Hussein Taji Kal Dari 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 content is copyrighted to the translators (listed above).