Skip to content

Commit

Permalink
Add README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
rioastamal committed Nov 3, 2018
1 parent 9426752 commit d58ba5c
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 0 deletions.
7 changes: 7 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2018 Rio Astamal \<rio@rioastamal.net\>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
## Tentang

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

Quran-web adalah project untuk menyajikan kitab suci Al-Quran dalam bentuk website yang ringan dan cepat. Sehingga perangkat dengan spesifikasi rendah pun dapat mengakses tanpa kesulitan. Fitur utama dari project ini adalah:

* Cepat dan ringan
* Mobile web frienldy
* Terjemahan Bahasa Indonesia
* Mode malam untuk kenyamanan membaca

## Latar Belakang

Latar belakang kenapa saya membuat project ini adalah karena pada handphone saya yaitu Blackberry Passport (SE) 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 melakukan juga membuat beberapa project Al-Quran lain diantarnya.

- [quran-text](https://github.com/rioastamal/quran-text)
- [quran-json](https://github.com/rioastamal/quran-json)
- [quran-single-file](https://github.com/rioastamal/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 **rio@rioastamal.net**.

## 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-single-file](https://github.com/rioastamal/quran-single-file).

### 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
$ 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\_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\_BASE\_URL | optional | Base URL dari website contoh: https://quranweb.id. Default = ""

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

```
$ rm -rf build/*
```

## Penulis

Project ini dibuat oleh Rio Astamal \<rio@rioastamal.net\>.

## 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.

0 comments on commit d58ba5c

Please sign in to comment.