GitHub - rioastamal/quran-web: QuranWeb is a simple and fast mobile web quran ba...

README.md

Tentang

Alhamdulillah puji syukur ke hadirat Allah SWT. Sholawat serta salam semoga selalu tercurahkan kepada Nabi Muhammad SAW.

QuranWeb adalah project untuk menyajikan kitab suci Al-Quran dalam bentuk website yang ringan dan cepat. Prinsip pengembangan yang digunakan adalah penggunaan Javascript seminimal mungkin dan zero dependencies. One page served by one HTML file.

Sehingga perangkat dengan spesifikasi rendah pun dapat mengakses tanpa kesulitan. Fitur utama dari QuranWeb adalah:

• Cepat dan ringan
• Mobile web frienldy
• Penanda terakhir dibaca
• Terjemahan Bahasa Indonesia
• Mode malam untuk kenyamanan membaca
• Pergi ke nomor ayat tertentu dalam satu surah

To do

Beberapa fitur yang akan ditambahkan pada versi yang akan datang adalah:

• Bookmark ayat
• Audio murottal untuk tiap surah atau ayat
• Setiap ayat memiliki halaman sendiri

Latar Belakang

Latar belakang kenapa saya membuat project ini adalah karena pada handphone Blackberry Passport (SE) yang saya miliki tidak ada aplikasi atau mobile website Quran yang dapat berjalan dengan baik di perangkat saya tersebut.

Kebanyakan mobile site tersebut menggunakan terlalu banyak javascript sehingga lambat atau kadang tampilannya tidak sesuai dengan yang saya inginkan. Sehingga saya berinisiatif untuk membuat situs mobile Quran static yang ringan dan juga mudah digunakan. Tentunya sesuai selera saya karena untuk saya gunakan pribadi.

Dalam proses pembuatan itulah saya juga membuat beberapa project Al-Quran lain diantaranya.

• quran-text
• quran-json
• quran-single-file

Sumber

Sumber utama ayat-ayat Al-Quran dan terjemahannya dalam project ini didapat dari situs dan aplikasi resmi dari Kementrian Agama Republik Indonesia yang dapat diakses di https://quran.kemenag.go.id.

Laporkan Kesalahan

Al-Quran adalah kitab suci sempurna yang diturunkan Allah SWT. segala bentuk kesalahan yang ada pada project ini adalah pasti karena kebodohan dan kekhilafan saya sendiri. Untuk itu mohon dengan hormat jika anda menemukan ada suatu kesalahan untuk menghubungi saya melalui email di [email protected].

Build

Untuk melakukan build anda memerlukan PHP interpreter pada sistem anda. Hasil build akan disimpan dalam direktori build/public. Konten dari direktori tersebut yang dapat anda upload ke server.

Script ini memerlukan file quran dan terjemahan yang ada pada project quran-json.

Cara menjalankan build

Semua konfigurasi build dapat diubah lewat environment variable. Proses build secara umum sangat cepat hanya memerlukan waktu kurang dari satu detik.

$ export QURAN_JSON_DIR=/path/to/directory/of/quran-json
$ export QURAN_BASE_URL=http://localhost:8080
$ php src/generator/generator.php
Generating website...done.

Berikut adalah daftar konfigurasi yang dapat diubah.

Konfigurasi Status Keterangan QURAN_JSON_DIR required Path ke quran-json project QURAN_BASE_URL required Base URL dari website contoh: https://quranweb.id. Tanpa slash diakhir. Default is tidak ada. QURAN_BEGIN_SURAH optional Awal surah. Default = 1 QURAN_END_SURAH optional Akhir surah. Default = 114 QURAN_TEMPLATE_DIR optional Path ke template directory. Default = src/generator/template QURAN_APP_NAME optional Nama dari website. Default = QuranWeb. QURAN_ANALYTICS_ID optional Google Analytics tracking id. Default tidak ada. QURAN_OG_IMAGE_URL optional OpenGraph image url. Default tidak ada.

Isi dari direktori build/ dapat anda hapus jika memang sudah tidak diperlukan.

$ rm -rf build/*

Penulis

Project ini dibuat oleh Rio Astamal <[email protected]>.

Kontribusi

Jika anda ingin melakukan kontribusi pada project ini silahkan lakukan Pull Request [PR] melalui Github.

Lisensi

Project ini dilisensikan dibawah naungan MIT License. Lihat file LICENSE.md.