Cara Menjalankan Dokumentasi Laravel 6 Secara Offline

Laravel 6 hadir dengan membawa perubahan dan fitur baru, salah satunya adalah perubahan pada website ofisial Laravel yang mana juga terdapat halaman dokumentasi Laravel.

Pada versi sebelumnya kita dapat mengunduh dokumentasi Laravel ke komputer agar dapat dibaca secara offline atau tanpa sambungan koneksi. Begitu pula pada versi 6 ini, bedanya Taylor Otwell —sang kreator Laravel— telah membuatkan repositori baru untuk website ofisial baru Laravel.com, yaitu https://github.com/laravel/laravel.com-next.git.

Pada repo baru ini, pihak Laravel memberikan panduan untuk menginstalnya secara lokal di komputer kita. Jadi kita bisa mengikuti panduan tersebut.

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. Lalu ketik:

git clone git@github.com:{username}/laravel.com-next.git laravel

Catatan:

1. Perintah di atas hanya bisa dilakukan jika kita melakukan fork pada repositori laravel.com-next.
2. laravel bisa diubah dengan nama apapun yang anda inginkan. Bila kita menuliskannya laravel maka isi repo laravel-com-next akan diunduh ke dalam folder laravel. Atau, bisa juga berarti nama repo aslinya diubah ke nama repo yang kita inginkan di komputer local kita.
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
4. Ganti {username} dengan username akun github-mu, misal: git clone https://github.com/fatoniid/laravel.com-next laravel

Tunggu hingga proses pengunduhan selesai atau muncul.

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

3. Jalankan setup.sh

Jika kita ingin mengunduh semua versi dokumentasi laravel dari versi 4.2 sampai 6.x (direkomendasikan), ikuti instruksi di bawah ini, jika hanya ingin mengunduh versi 6.x saja, silahkan skip dan baca pada bagian "Cara clone repositori docs" untuk melakukan clone dan perintah lainnya secara manual.

Masuklah ke dalam folder laravel (jika kita memberi nama reponya laravel):

cd laravel

Lalu jalankan skrip setup.sh, ketik:

.bin/setup.sh

Skrip di atas akan menjalankan secara otomatis perintah:

1. cp .env.example .env

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

2. php artisan key:generate

Perintah ini adalah untuk menggenerate key aplikasi.

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

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

5. 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 6.x https://github.com/laravel/docs.git "resources/docs/6.x" 

Tunggu hingga proses clone selesai.

Setelah itu, jalankan perintah:

npm install
npm run dev

Jika ingin melihatnya di browser, ketik:

php artisan serve