Kontribusi

Setup

  1. Install aplikasi Github Desktop. Ini opsional sih, tapi bisa membantu mengelola branch dan memudahkan Pull Request.

  2. Jika sudah terdaftar sebagai Contributor, bisa langsung clone Laravolt dari https://github.com/laravolt/laravolt

  3. Jika belum terdaftar sebagai Contributor, silakan fork dan clone repository Laravolt milikmu sendiri.

  4. Laravolt adalah sebuah package, jadi untuk mencobanya kita harus meng-install Laravel terlebih dahulu.

    composer create-project --prefer-dist laravel/laravel sandbox

    Silakang diselesaikan instalasinya hingga selesai sesuai dokumentasi.

  5. Sampai disini, struktur folder yang sudah kita buat adalah:

    ├── sandbox (folder Laravel)
    │   ├── README.md
    │   ├── app
    │   ├── artisan
    │   ├── bootstrap
    │   ├── ...
    ├── laravolt (folder Laravolt)
    │   ├── README.md
    │   ├── bin
    │   ├── composer.json
    │   ├── composer.lock
    │   ├── monorepo-builder.yml
    │   ├── packages
    └───└── vendor
  6. Edit file sandbox/composer.json, tambahkan potongan kode "repositories" berikut tepat di atas blok "require":

    "repositories": [
      {
        "type": "path",
        "url": "../laravolt/",
        "options": {
          "symlink": true
        }
      }
    ],
    "require": {
    
    },
  7. Selanjutnya, masuk ke folder sandbox dan jalankan beberapa langkah instalasi Laravolt berikut ini:

    cd sandbox
    composer require laravolt/laravolt

    Laravel 6

    php artisan preset laravolt

    Laravel 7

    php artisan ui laravolt
    php artisan vendor:publish --tag=migrations
    php artisan migrate
    php artisan laravolt:admin Admin admin@laravolt.dev secret
  8. Install dan compile Assets

    Yarn user

    yarn install
    yarn run dev

    NPM user

    npm install
    npm run dev
  9. Jalankan php artisan server atau web server lain kesayanganmu. Pastikan ketika diakses di browser (misalnya http://localhost:8000), muncul halaman login. Gunakan credentials sesuai yang diisikan pada langkah sebelum ini.

Development

Setelah setup selesai, kamu bisa mulai koding menyempurnakan Laravolt. Ingat, kita punya dua buah folder:

  1. Folder sandbox bertindak sebagai aplikasi, semua perubahan disini tidak akan dicommit ke Laravolt. Folder ini digunakan untuk menguji apakah perubahan yang kita lakukan sudah sesuai dengan harapan atau belulm.
  2. Folder laravolt berisi source code Laravolt. Perubahan yang dilakukan disini akan dicommit + dimerge ke repository Laravolt.
├── README.md
├── bin
│   ├── build.sh
│   └── split.sh
├── composer.json
├── composer.lock
├── monorepo-builder.yml
└── packages
    ├── camunda
    ├── comma
    ├── epilog
    ├── lookup
    ├── mailkeeper
    ├── media
    ├── menu
    ├── platform
    ├── semantic-form
    ├── suitable
    ├── support
    ├── thunderclap
    └── workflow
  1. Pastikan selalu membuat branch baru sebelum mulai koding, dengan format:
    1. feature/<nama-feature>
    2. bug/<nama-bug>
  2. Pastikan sudah ada isu terkait di https://github.com/laravolt/laravolt/issues. Jika belum ada, silakan tambahkan isu baru.
  3. Jika koding sudah selesai, lakukan Pull Request:
    1. Melalui aplikasi desktop
    2. Atau melalui web
  4. Selamat bersenang-senang ⚡️