Skip to content

Commit 1d93622

Browse files
authored
Update README.md
add notice about mini dump
1 parent 4a35743 commit 1d93622

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ bundle install
8383

8484
#### 5. Database Configuration
8585

86-
**The QUL project requires two databases:**
86+
**QUL requires two databases:**
8787

8888
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.
9090

9191
#### 6. Create Databases
9292
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
9999
#### 7. Load the data for **`quran_dev`** database
100100
The `quran_dev` database dump is available in both SQL and binary formats. Follow the appropriate instructions below to restore the database.
101101

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+
102110
#### Restoring from SQL Dump
103111
7.1 **Restore using SQL Dump:**
104112
Download the [SQL dump file](https://static-cdn.tarteel.ai/qul/mini-dumps/quran_dev.sql.zip) and restore it using

0 commit comments

Comments
 (0)