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
179 commits 1 branch 0 tags 8 MiB
Find a file
0x1eef f4483b62e4 Restructure the object that describes a surah. 
The object is now structured differently:

{
  id: number,
  name: {
    codepoints: number[],
    translated: string,
    transliterated: string
  },
  origin: "makkah" | "medina",
  ayahs: number,
  slug: string,
  translator: string
}
2023-09-17 00:08:32 -03:00
bin Add Cmd::Pull 2023-03-27 01:47:23 -03:00
lib/quran-json/quran Restructure the object that describes a surah. 2023-09-17 00:08:32 -03:00
libexec/quran-json Add Cmd::Pull 2023-03-27 01:47:23 -03:00
share/quran-json Restructure the object that describes a surah. 2023-09-17 00:08:32 -03:00
.gitignore Add -o, --overwrite option 2023-02-09 06:40:36 -03:00
.rubocop.yml .rubocop.yml: update 2023-03-27 01:48:32 -03:00
.sqliterc add sample .sqliterc file. 2022-06-11 17:45:14 -03:00
Gemfile Restructure the object that describes a surah. 2023-09-17 00:08:32 -03:00
Gemfile.lock Restructure the object that describes a surah. 2023-09-17 00:08:32 -03:00
LICENSE License = GPL 2023-03-11 12:22:16 -03:00
README.md README: update 2023-07-04 23:40:15 -03:00
VERSION v0.12.0 2023-03-27 01:49:12 -03:00

README.md

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

First and foremost, Alhamdulillah.

Thanks to the following websites for providing the downloadable content:

And 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).