Skip to content

adelpro/mushaf-imad-expo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

141 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mushaf Imad Expo

Version Expo React Native iOS Android License Athar

A React Native Quran reading application built with Expo, featuring page-by-page Quran rendering with interactive verse support.

Table of Contents

Overview

Mushaf Imad Expo is a reusable Quran page rendering component for Expo applications. It displays Quran pages with support for interactive verses, chapter information, and customizable layouts.

Features

  • Page Rendering: Displays all 604 pages of the Quran with high-quality images
  • Interactive Verses: Tap on verses to get more information or perform actions
  • Chapter Navigation: Sura name bars with press support for chapter details
  • Verse Markers: Visual markers for verse numbers (fasel) with press support
  • Verse Highlights: Visual highlighting of verse content areas
  • Info Popups: Built-in popups for verse and chapter information
  • SQLite Database: Efficient local storage using Expo SQLite

Screenshots

Quran View - Main Interface

Quran View - Detailed View

Quick Start

Installation

# Clone the repository
git clone https://github.com/your-repo/mushaf-imad-expo.git
cd mushaf-imad-expo

# Install dependencies
yarn install

# Start the development server
yarn start

Running on Platforms

# Run on Android
yarn android

# Run on iOS
yarn ios

# Run on Web
yarn web

Project Structure

mushaf-imad-expo/
├── assets/
│   ├── images/quran/      # Quran page images (604 folders)
│   ├── fonts/             # Application fonts
│   └── quran.db           # SQLite database
├── docs/
│   ├── quran-component.md # Quran component documentation
│   └── migration-realm-to-sqlite.md # Migration documentation
├── screenshots/           # Application screenshots
├── src/
│   ├── components/
│   │   └── quran/        # Quran rendering components
│   ├── services/
│   │   └── SQLiteService.ts
│   ├── hooks/
│   └── screens/
├── scripts/
│   ├── generate-map.js    # Generate image map for Expo
│   └── migrate-realm-to-sqlite.js
└── package.json

Documentation

Dependencies

Core Dependencies

  • expo - Expo framework
  • react-native - React Native
  • expo-sqlite - SQLite database
  • expo-asset - Asset management
  • react-native-svg - SVG rendering

Development Dependencies

  • typescript - TypeScript compiler
  • better-sqlite3 - SQLite native bindings
  • react-native-svg-transformer - SVG transformation

Scripts

Command Description
yarn start Start Expo development server
yarn generate-map Generate image map for Quran pages
yarn prebuild Generate native projects
yarn android Run on Android device/emulator
yarn ios Run on iOS simulator
yarn web Run in web browser

Database

The application uses SQLite for storing Quran data including:

  • Chapters: 114 Quran chapters
  • Pages: 604 Quran pages
  • Verses: 6,236 Quran verses
  • Verse Highlights: 27,039 highlight positions
  • Chapter Headers: 228 chapter title markers
  • Page Headers: 1,208 page header markers

Database Initialization

The database is pre-populated from assets/quran.db and copied to the device on first launch.

Image Assets

Quran page images are organized in assets/images/quran/ with 604 folders, one for each page.

Note: Run yarn generate-map after modifying image assets to update the image import map.

Version

  • Current Version: 1.0.0
  • Package: com.adelpro.mushafimadrn

Acknowledgments

Special thanks to the ITQAN Community for their support and contribution to the Quran technology ecosystem.

ITQAN Community Logo

License

Private project - All rights reserved.

About

A React Native Quran reading application built with Expo, featuring page-by-page Quran rendering with interactive verse support.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors