Proyek ini bertujuan untuk membangun aplikasi web pengelolaan limbah elektronik (e-waste) menggunakan Laravel untuk backend dan TailwindCSS untuk frontend. Aplikasi ini memungkinkan pengguna untuk mengajukan permintaan daur ulang dan melacak status pembuangan limbah elektronik mereka.
- Laravel: 11.28
- Tailwind CSS: 3
- PHP: 8.3.12
- Node.js: 20.18.0
- MySQL: 8.3.0
Untuk menjaga konsistensi dan keterbacaan kode, kami menggunakan PSR-1 dan PSR-4 sebagai standar utama:
-
PSR-1: Merupakan standar dasar kode PHP yang merekomendasikan penggunaan coding style yang umum untuk meningkatkan keterbacaan dan kompatibilitas kode PHP di berbagai proyek. PSR-1 mencakup aturan seperti penggunaan
<?php
dan standar nama kelas. -
PSR-4: Standar ini mendefinisikan aturan autoloading untuk project PHP menggunakan namespaces. Dengan PSR-4, kelas PHP dapat dipetakan ke file sistem berdasarkan namespace-nya, memudahkan pengelolaan file dan struktur folder.
Untuk menjaga keteraturan dalam penamaan, berikut adalah aturan naming convention yang digunakan di proyek ini:
-
Controller: Menggunakan Pascal Case (contoh:
UserController
,ProductController
). -
Database: Menggunakan Snake Case (semua yang berhubungan dengan database, contoh:
user_data
,product_list
). -
Variable: Menggunakan Camel Case (contoh:
$userData
,$productList
). -
Model: Menggunakan Pascal Case (contoh:
User
,Product
). -
Properti Model: Menggunakan Snake Case (karena berhubungan dengan database, contoh:
user_name
,created_at
). -
Metode Model: Menggunakan Camel Case (contoh:
getUserData()
,saveProduct()
). -
Blade View: Menggunakan Kebab Case (contoh:
user-profile.blade.php
,product-list.blade.php
).
Referensi tambahan mengenai convention di Laravel:
Link Sumber
Unduh alat yang diperlukan melalui link Google Drive ini.
Untuk memulai, klon proyek dari GitHub dengan perintah berikut:
git clone https://github.com/ProyekPerangkatLunak-B/e-waste-ppl-b.git 'nama-proyek'
cd nama-proyek
- PHP dependencies dengan Composer:
composer install
- Node packages dengan npm:
npm install
Buat file .env
:
cp .env.example .env
php artisan key:generate
- Konfigurasi Database: Sesuaikan detail database di file
.env
:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=ewaste
DB_USERNAME=root
DB_PASSWORD=
Jalankan migrasi database:
php artisan migrate
- Jalankan server development Laravel:
php artisan serve
- Jalankan build frontend development:
npm run dev
Buat branch baru sesuai dengan tugas yang dikerjakan menggunakan konvensi berikut contohnya:
- Frontend Task:
recycleme-frontend
- Backend Task:
recycleme-backend
Contoh:
git checkout -b recycleme-frontend
Pastikan untuk commit pekerjaan dengan pesan yang jelas dan deskriptif:
git commit -m "Recycleme-frontend: Menambahkan fitur baru"
Catatan: Selalu push ke branch masing-masing, bukan langsung ke dev
.
Sebelum memulai pekerjaan, pastikan untuk menarik (pull) perubahan terbaru dari dev
:
git checkout dev
git pull
Sebelum memulai pekerjaan, pastikan untuk mengecek digrup apakah ada update dependencies npm atau composer
:
npm install
composer install
Setelah melakukan pull pada branch dev, pidahlah kebranch masing - masing sesuai dengan jobdesk:
git checkout nama-branch
Jika tidak bisa menggunakan git pull
Coba Gunakan ini:
git pull origin dev
Setelah menyelesaikan pekerjaan, push perubahan ke branch masing-masing:
git add .
git commit -m "Pesan commit yang deskriptif sesuuai dengan contoh yang sudah diberikan"
git push origin nama-branch
Last Edited 31/10/24 @e-waste-ppl-b