README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# OpenQuran
<img src="src/images/favicon.png" width="250px" align="right">

ِبِسْمِ اللَّهِ الرَّحْمَنِ الرَّحِيْم

السَّلاَمُ عَلَيْكُمْ وَرَحْمَةُ اللهِ وَبَرَكَاتُهُ

OpenQuran is an online & offline (for Windows) Al-Qur'an Reader website & app. 

## Features

- Al-Qur'an
- Sura List
- Translation
	- English
	- Indonesia
- Zooming

## Installation

### Download from Releases (Windows)
1. Download the .zip file [here](https://github.com/altaf-creator/OpenQuran/releases/tag/v1.1.0)
2. Unzip the file
3. Open the `OpenQuran` shortcut on the unzipped root folder **OR** navigate to `\OpenQuran-win32-x64` then open `OpenQuran.exe`

### Compile using Electron Forge
1. Clone the repository using `git clone https://github.com/altaf-creator/OpenQuran.git`
2. Navigate to OpenQuran
3. Install dependencies using `npm install`
4. To preview your electron app, run `npm start`
5. To build your electron app, run `npm run make`

### Add to Homescreen (Browser)
1. Open OpenQuran's website [here](https://altaf-creator.github.io/OpenQuran/)
2. Click your browser's menu (usually ⋯)
3. Click "Add to Homescreen" or "Install App"

## Screenshots

![screenshot 1](readme-assets/screenshots/1.png)
![screenshot 2](readme-assets/screenshots/2.png)
![screenshot 3](readme-assets/screenshots/3.png)
![screenshot 4](readme-assets/screenshots/4.png)


## Credits & Attribution

- [The Tanzil Project](https://tanzil.net)
- [Made with Electron](https://www.electronjs.org/)