quran-json/README.md

The Qur'an

This repository contains the holy book, The Qur'an, in both English and its original Arabic, and described in the JSON format. The repository hopes to help those working with The Qur'an in the context of developing software, or websites.

Layout

The src/ directory

The src/arabic/ directory contains The Qur'an in its original Arabic.
The src/english/ directory contains an English translation of The Qur'an.

Arabic

• src/arabic/

Each JSON file represents a chapter, or surah - in its original Arabic. For example, src/arabic/1.json contains Al-Fatihah. The structure of the file can be described as an array of arrays, with each array representing a verse, or ayah. For example:

[
  [
    <verse number>,
    <verse contents>
  ],
  [
    <verse number>,
    <verse contents>
  ],
  [
    <verse number>,
    <verse contents>
  ],
  /* etc... */
]

English

• src/english/

The English translation follows the same structure as the Arabic content, with each JSON file representing a chapter, or surah. Like the Arabic JSON files, the data is stored in an array of arrays. For example, consider Al-Fatihah - src/english/1.json:

[
  [
    1,
    "In the Name of Allah—the Most Compassionate, Most Merciful."
  ],
  [
    2,
    "All praise is for Allah—Lord of all worlds,"
  ],
  [
    3,
    "the Most Compassionate, Most Merciful,"
  ],
  [
    4,
    "Master of the Day of Judgment."
  ],
  [
    5,
    "You ˹alone˺ we worship and You ˹alone˺ we ask for help."
  ],
  [
    6,
    "Guide us along the Straight Path,"
  ],
  [
    7,
    "the Path of those You have blessed—not those You are displeased with, or those who are astray. "
  ]
]

The bin/ directory

The bin/ directory contains two scripts that generate the contents of the src/ directory:

• bin/pull-arabic
  This script is responsible for populating src/arabic/.

• bin/pull-english
  This script is responsible for populating src/english/.

Notes

The scripts are written in Ruby v3.1.0+.
The "pull-english" script depends on the "pull-arabic" script being run first.
The script dependencies can be installed by running gem install -g gem.deps.rb from the root of the repository.

Credit, and thanks

The content of this repository was automatically generated thanks to the following websites:

• https://sacred-texts.com - for the original Arabic.
• https://quran.com - for the English translation.