Pemrograman

Cara Membaca Dokumentasi Laravel secara Offline

Update: September 2020

Jika anda seorang pengguna dan pembelajar framework Laravel tentu anda akan sering membuka dokumentasi Laravel di https://laravel.com/docs/. Ternyata dokumentasi di laravel.com ini bisa anda unduh karena source code-nya terdapat di GitHub sehingga bisa anda jalankan secara offline di lokal komputer.

  1. Fork Repositori

Fork bersifat opsional, tergantung apakah kita perlu melakukan fork atau tidak. Namun, direkomendasikan untuk melakukan fork sesuai panduan yang diberikan Laravel agar repositorinya tersalin dalam akun github kita sehingga memudahkan saat melakukan clone dengan SSH. Selain melakukan fork pada repo laravel.com-next, lakukan fork juga pada repo docs yang beralamat di: https://github.com/laravel/docs.

2. Clone Repositori

Ini seperti mengunduhnya ke dalam komputer kita. Buka terminal dan arahkan pada folder sebagai tempat untuk meletakan repo laravel.com-next di komputer kita, misal di htdocs atau sites. Lalu ketik:

git clone [email protected]:{username}/laravel.com-next.git laravel.com

Catatan:

  1. Perintah di atas hanya bisa dilakukan jika kita melakukan fork pada repositori laravel.com-next. Jika tidak, anda bisa melakukan clone seperti biasa. git clone https://github.com/laravel/laravel.com-next.git laravel.com
  2. laravel.com hanya opsional, jika anda tidak menuliskannya maka foldernya akan menjadi laravel.com-next yang kemudian bisa anda rename jika anda ingin mengubahnya.
  3. Ekstensi .git pada laravel.com-next.git bisa tidak disertakan sehingga kita bisa menuliskan sebagai berikut: git clone https://github.com/{username}/laravel.com-next laravel.com
  4. Ganti {username} dengan username akun github-mu, misal: git clone https://github.com/cafeteria/laravel.com-next laravel.com

Tunggu hingga proses cloning selesai.

Resolving deltas: 100% (1624/1624), done.

3. Jalankan setup.sh

Catatan: Langkah ini hanya bagi anda yang ingin mengunduh semua versi dokumentasi laravel dari versi 4.2 sampai 8.x (direkomendasikan). Namun, bagi anda yang hanya ingin mengunduh dokumentasi versi tertentu (tidak semua dokumentasi) silahkan skip langkah ini dan tuju ke bagian “Cara Clone Repositori Docs” pada bagian bawah setelah pembahasan ini.

Masuk ke dalam folder yang baru saja anda clone: cd laravel.com

Buka Git Bash dengan cara klik kanan pada area dalam folder, pilih Git Bash Here. Ketik:

sh bin/setup.sh

Perintah di atas akan menjalankan secara otomatis perintah:

  1. cp .env.example .env

Perintah ini adalah untuk menyalin file .env.example dan mengubahnya menjadi .env.

  1. php artisan key:generate

Perintah ini adalah untuk menggenerate key aplikasi.

  1. source “$(dirname “$0″)/checkout_latest_docs.sh”

Memanggil dan menjalankan skrip checkout_latest_docs.sh yang akan meng-clone semua versi dokumentasi Laravel dari versi 4.2 hingga 6.x secara otomatis. Kita akan berulang kali memasukkan passphrase untuk setiap versi yang kita clone sehingga jangan tinggalkan. Apabila lama kita tidak memasukkan passphare, bisa saja akan gagal untuk meng-clone versi 6.x (karena versi ini yang lebih dulu diclone hingga yang terakhir adalah versi 4.2) yang menyebabkan dokumentasi 6.x tidak ada dalam folder docs.

  1. npm install

Perintah ini untuk menginstal modul (package) atau library javascript yang terdapat dalam package.json dan akan menggenerate file package-lock.json untuk me-lock versi package yang terinstal.

  1. npm run dev

Perintah ini untuk menjalankan webpack.mix.js sehingga hasilnya adalah file css dan js.

Jika hasil layar pada terminal menyatakan DONE dengan keterangan Compiled successfully in …, artinya kita sudah berhasil menyelesaikan semua proses.

Tahap terakhir untuk menampilkannya di browser, kita bisa menjalankan perintah berikut:

php artisan serve

Cara Clone Repositori Docs

Bagian ini khusus untuk anda yang memilih skip menjalankan setup,sh. Sebelum anda melakukan clone repo docs, pastikan anda sudah menjalankan perintah berikut:

cp .env.example .env
php artisan key:generate

Kemudian, dengan terminal jalankan perintah clone, ketik:

git clone --single-branch --branch 8.x https://github.com/laravel/docs.git "resources/docs/8.x"

Tunggu hingga proses clone selesai.

Setelah itu, jalankan perintah:

npm install
npm run dev

Jika ingin melihatnya di browser, ketik:

php artisan serve

Sayangnya untuk versi offline Anda tidak bisa menggunakan fitur pencarian.  

Selamat mencoba…

cafeteria

You may also like

Leave a reply

Your email address will not be published. Required fields are marked *

More in Pemrograman