0x1eef
2d9a22ea8f
The project's directory structure has been changed to be similar to how FreeBSD organizes its filesystem. The english, portuguese, and farsi translations are now sourced from https://quran.com. The original Arabic is still sourced from searchtruth.com. Files have been removed, and / or replaced. The SQL-related files have been removed, with the intention to separate them into a new project in the future (quran-sql). The lessons learnt from the development of quran-audio were an inspiration for this change. |
||
|---|---|---|
| bin | ||
| lib/quran-pull | ||
| libexec/quran-pull | ||
| share/quran-pull | ||
| .gitignore | ||
| .rubocop.yml | ||
| .ruby-version | ||
| .sqliterc | ||
| Gemfile | ||
| Gemfile.lock | ||
| README.md | ||
| VERSION | ||
About
This repository contains the contents of the holy book, The Quran - in its original Arabic. Translations in English, Farsi, and Portuguese are also included. The contents are available in the JSON, and SQL formats.
Contents
src/json/
- src/json/ar/ contains The Quran in its original Arabic.
- src/json/en/ contains an English translation of The Quran.
- src/json/fa/ contains a Farsi translation of The Quran.
- src/json/pt/ contains a Portuguese translation of The Quran.
JSON schema
Each JSON file represents a surah (also known as a chapter). The format of the JSON files 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 is made up of two-element arrays. The first element is the ayah number (also known as a verse number), and the second element is the contents of the ayah. See Surah Al-Fatihah as an example.
src/sql/
- src/sql/schema.sql defines the schema of the database.
- src/sql/seed.sql can be used to populate a SQL database.
- src/sql/queries/ contains example SQL queries.
bin/
The bin/ directory contains scripts that generate the contents of the src/ directory:
-
JSON scripts
- bin/json/pull-arabic
This script populates src/json/ar/. - bin/json/pull-english
This script populates src/json/en/. - bin/json/pull-farsi
This script populates src/json/fa/. - bin/json/pull-portuguese
This script populates src/json/pt/.
- bin/json/pull-arabic
-
SQL scripts
- bin/sql/create-sql-seed-file
This script creates src/sql/seed.sql.
- bin/sql/create-sql-seed-file
Thanks
First and foremost, Alhamdulillah.
I'd also like to extend thanks to the following websites for providing the content that quran-pull downloads:
- https://searchtruth.com for the original Arabic.
- https://quran.com for the English, Portuguese, and Farsi translations.
License
Public domain.