You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,10 +83,10 @@ bundle install
83
83
84
84
#### 5. Database Configuration
85
85
86
-
**The QUL project requires two databases:**
86
+
**QUL requires two databases:**
87
87
88
88
1.**`quran_dev`**: This database holds all Quranic data, including translations, tafsirs, audio etc. It's accessed through `quran_api_db_dev` for the development environment.
89
-
2.**`quran_community_tarteel`**: This database manages user accounts, permissions, and user changes.
89
+
2.**`quran_community_tarteel`**: This database hold data about user accounts, permissions, and user generated content and change log about translations.
90
90
91
91
#### 6. Create Databases
92
92
Create the **`quran_community_tarteel`** database for managing user content.
@@ -99,6 +99,14 @@ For **`quran_dev`** you can create it manually or change the database name to `q
99
99
#### 7. Load the data for **`quran_dev`** database
100
100
The `quran_dev` database dump is available in both SQL and binary formats. Follow the appropriate instructions below to restore the database.
101
101
102
+
> **Mini Database Dump for Development**
103
+
>
104
+
> The database backup provided below contains a limited subset of data, specifically selected for local development and testing. It is not a full production database and is intended solely for development and contribution purposes.
105
+
>
106
+
> We **do not provide or share** the full database backup. This mini dump contains all the essential data required to run QUL locally or contribute new features. If you're working on a feature that need more data, please open an issue.
107
+
> If you're looking for specific resource, please visit our [Resources page](https://qul.tarteel.ai/resources/) to download it.
108
+
109
+
102
110
#### Restoring from SQL Dump
103
111
7.1 **Restore using SQL Dump:**
104
112
Download the [SQL dump file](https://static-cdn.tarteel.ai/qul/mini-dumps/quran_dev.sql.zip) and restore it using
0 commit comments