ReflectsLight/quran-json
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: update / sync with recent changes.

Browse source
This commit is contained in:
0x1eef 2022-10-06 09:13:00 -03:00 committed by 0x1eef
parent d5a707e8a3
commit 3b836e71b3
1 changed files with 38 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -34,7 +34,8 @@ and modified slightly.
The [chapter-metadata.json](/src/json/chapter-metadata.json) file contains information about each The [chapter-metadata.json](/src/json/chapter-metadata.json) file contains information about each
chapter in The Qur'an. It is structured as an array of objects, with each object describing chapter in The Qur'an. It is structured as an array of objects, with each object describing
a given chapter. The following example demonstrates how Al-Fatihah is described as an object. a given chapter. The following example demonstrates how Al-Fatihah is described as an object.
The "codepoints" property is a sequence of unicode codepoints can be mapped back to an Arabic word: The "codepoints" property is a sequence of unicode codepoints that can be mapped back
to Arabic - for example by using JavaScript's `String.fromCodePoint(...codepoints)`.
```json ```json
{ {
@ -64,12 +65,15 @@ The Arabic translation was obtained from the website https://sacred-texts.com.
Each JSON file represents a chapter, or surah - in its original Arabic. Each JSON file represents a chapter, or surah - in its original Arabic.
For example, [src/json/ar/1.json](src/json/ar/1.json) contains Al-Fatihah. For example, [src/json/ar/1.json](src/json/ar/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. The structure of the file can be described as an array whose first element is an
For example: object that contains information aboout the chapter, and the rest of the array is composed
of two-element arrays - the first element being the verse number, and the second element
being the contents of the verse. For example:
``` ```
[ [
{ <chapter metadata> },
[ [
<verse number>, <verse number>,
<verse contents> <verse contents>
@ -94,13 +98,16 @@ The English translation is a copy of "The Clear Quran" - by Dr. Mustafa Khattab,
and it was obtained from the website https://quran.com. and it was obtained from the website https://quran.com.
Each JSON file represents a chapter, or surah - as an English translation. Each JSON file represents a chapter, or surah - as an English translation.
The structure of the file can be described as an array of arrays, For example, [src/json/en/1.json](src/json/en/1.json) contains Al-Fatihah.
with each array representing a verse, or ayah. For example, consider
the English translation of Al-Fatihah ([src/json/en/1.json](src/json/en/1.json)):
The structure of the file can be described as an array whose first element is an
object that contains information aboout the chapter, and the rest of the array is composed
of two-element arrays - the first element being the verse number, and the second element
being the contents of the verse. For example:
``` ```
[ [
{ <chapter metadata> },
[ [
1, 1,
"In the Name of Allah—the Most Compassionate, Most Merciful." "In the Name of Allah—the Most Compassionate, Most Merciful."
@ -140,12 +147,15 @@ The Farsi translation was obtained from the website https://al-quran.cc.
Each JSON file represents a chapter, or surah - as a Farsi translation. Each JSON file represents a chapter, or surah - as a Farsi translation.
For example, [src/json/fa/1.json](src/json/fa/1.json) contains Al-Fatihah. For example, [src/json/fa/1.json](src/json/fa/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. The structure of the file can be described as an array whose first element is an
For example: object that contains information aboout the chapter, and the rest of the array is composed
of two-element arrays - the first element being the verse number, and the second element
being the contents of the verse. For example:
``` ```
[ [
{ <chapter metadata> },
[ [
<verse number>, <verse number>,
<verse contents> <verse contents>
@ -170,12 +180,15 @@ The Portuguese translation was obtained from the website https://al-quran.cc.
Each JSON file represents a chapter, or surah - as a Portuguese translation. Each JSON file represents a chapter, or surah - as a Portuguese translation.
For example, [src/pt/1.json](src/json/pt/1.json) contains Al-Fatihah. For example, [src/pt/1.json](src/json/pt/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. The structure of the file can be described as an array whose first element is an
For example: object that contains information aboout the chapter, and the rest of the array is composed
of two-element arrays - the first element being the verse number, and the second element
being the contents of the verse. For example:
``` ```
[ [
{ <chapter metadata> },
[ [
<verse number>, <verse number>,
<verse contents> <verse contents>
@ -217,8 +230,7 @@ and PostgreSQL should be able to import the SQL files as well, but have not been
**1. $HOME/.sqliterc** **1. $HOME/.sqliterc**
For identical results, it is recommended that the `$HOME/.sqliterc` file has the following For identical results - it is recommended that `$HOME/.sqliterc` has the following contents:
contents:
``` ```
PRAGMA case_sensitive_like=ON; PRAGMA case_sensitive_like=ON;
@ -230,8 +242,8 @@ pragma FOREIGN_KEYS = on;
**2. Import / save the database to disk** **2. Import / save the database to disk**
The `.save` command can be used to save the database to disk permanently. The `.save` command can be used to save the database to disk permanently, and
This helps avoid continually importing the database into memory - which is done by steps 1 and 2 in this example: avoid repeatedly importing the database into memory:
``` ```
sqlite> .read src/sql/schema.sql sqlite> .read src/sql/schema.sql
@ -240,8 +252,7 @@ sqlite> .save src/sql/quran.db
sqlite> .exit sqlite> .exit
``` ```
From now on, sqlite3 can be started with the path to the database SQLite3 can now be started with the path to the database saved to disk:
saved to disk instead loading into memory each time:
``` ```
$ sqlite3 src/sql/quran.db $ sqlite3 src/sql/quran.db
@ -252,9 +263,9 @@ id
sqlite> sqlite>
``` ```
**5. Query the database** **3. Query the database**
5.1 3.1
After the previous steps, the database is fully populated and exists After the previous steps, the database is fully populated and exists
on disk. We can now query the database and its contents. The SQL on disk. We can now query the database and its contents. The SQL
@ -287,7 +298,7 @@ en Al-Ikhlas 112 3 He has never had offspring, nor was He b
en Al-Ikhlas 112 4 And there is none comparable to Him.” en Al-Ikhlas 112 4 And there is none comparable to Him.”
``` ```
5.2 3.2
The next query we will execute demonstrates how to find a particular word or The next query we will execute demonstrates how to find a particular word or
phrase in the English translation of The Qur'an - using the LIKE operator: phrase in the English translation of The Qur'an - using the LIKE operator:
@ -344,6 +355,11 @@ contents of the [src/](src/) directory:
* [bin/json/pull-chapter-metadata](bin/json/pull-chapter-metadata) <br> * [bin/json/pull-chapter-metadata](bin/json/pull-chapter-metadata) <br>
The script is responsible for generating [src/json/chapter-metadata.json](src/json/chapter-metadata.json). The script is responsible for generating [src/json/chapter-metadata.json](src/json/chapter-metadata.json).
* [bin/json/insert-chapter-metadata](bin/json/insert-chapter-data) <br>
This script is responsible for inserting chapter metadata as the first element
of a JSON array that otherwise contains the contents of a chapter
(eg [src/json/ar/1.json](src/json/ar/1.json), ...).
* SQL scripts * SQL scripts
* [bin/sql/create-sql-seed-file](bin/sql/create-sql-seed-file) <br> * [bin/sql/create-sql-seed-file](bin/sql/create-sql-seed-file) <br>