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
149 commits 1 branch 0 tags 8 MiB
Find a file
0x1eef d99c5f688a Add "translated_by" to Italian translation
2023-02-13 01:05:08 -03:00
bin Dynamically map locale to libexec script 2023-02-12 12:44:33 -03:00
lib/quran-json Add Italian 2023-02-12 13:56:47 -03:00
libexec/quran-json Add Italian 2023-02-12 13:56:47 -03:00
share/quran-json Add "translated_by" to Italian translation 2023-02-13 01:05:08 -03:00
.gitignore Add -o, --overwrite option 2023-02-09 06:40:36 -03:00
.rubocop.yml The great rewrite 2023-02-08 16:14:48 -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 The great rewrite 2023-02-08 16:14:48 -03:00
README.md Fix typo 2023-02-12 14:06:22 -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. In both scenarios, the content is provided in the JSON format.

share/ directory

JSON layout

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/ directory

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)
  -o, --overwrite            Overwrite existing JSON files (default: no)

Thanks

First and foremost, Alhamdulillah.

And thanks to the following websites for providing the content that quran-json downloads:

License

Public domain.