Skip to content

Open source project to create starter backend using laravel

License

Notifications You must be signed in to change notification settings

xavierspacelix/backend-starter-laravel

 
 

Repository files navigation

Laravel Backend Starter

Laravel Backend Starter adalah sebuah proyek boilerplate untuk memulai pengembangan Restfull API untuk kebutuhan CMS menggunakan framework Laravel. Proyek ini bertujuan untuk memudahkan proses awal pembuatan aplikasi backend dengan menyediakan struktur dasar yang sudah siap digunakan.

Fitur Utama

Authentication

  • Menggunakan JWT (JSON Web Tokens) untuk autentikasi.
  • Menyediakan endpoint untuk login pengguna.
  • Menyediakan endpoint untuk registrasi pengguna.

Role & Permission

  • Mengelola daftar peran (role) yang diberikan kepada pengguna.
  • Mengatur hak akses (permission) untuk setiap peran.
  • Menentukan akses ke fitur dan sumber daya berdasarkan peran dan izin.

Custom List Menu (with permission)

  • Memungkinkan pengguna untuk menyesuaikan daftar menu dalam aplikasi.
  • Integrasi dengan sistem peran dan izin untuk mengatur kustomisasi menu.

User Management

  • Menyediakan endpoint untuk manajemen pengguna seperti pembuatan, pengeditan, dan penghapusan pengguna.
  • Memberikan fungsionalitas untuk mengatur peran dan izin pengguna.
  • Mengelola informasi profil pengguna.

Send Mail Notification

  • Mengintegrasikan layanan email untuk mengirim pemberitahuan kepada pengguna.
  • Menyediakan fungsi untuk mengatur dan mengirim pesan email secara otomatis.

Fitur Tambahan

General Helper

  • Menyediakan kumpulan fungsi bantuan umum yang dapat digunakan di seluruh aplikasi.
  • Contoh fungsi termasuk validasi data, manipulasi string, dan format tanggal.

Log Exception Handler

  • Merekam pengecualian (exception) yang terjadi dalam aplikasi.
  • Menyediakan laporan terperinci tentang pengecualian untuk tujuan pemantauan dan debugging.
  • Memberikan pemahaman yang lebih baik tentang masalah yang muncul dalam sistem.

Instalasi

Persyaratan Sistem

Pastikan sistem Anda sudah memenuhi persyaratan berikut sebelum memulai instalasi:

  • PHP >= 8.1
  • Composer
  • MySQL atau database lainnya yang didukung oleh Laravel

Langkah-langkah Instalasi

  1. Clone repositori ini ke dalam direktori lokal Anda:

    https://github.com/AcongDev/backend-starter-laravel.git
  2. Masuk ke direktori proyek:

    cd backend-starter-laravel
  3. Salin file .env.example menjadi .env dan sesuaikan pengaturan database Anda:

    cp .env.example .env
  4. Instal semua dependensi PHP menggunakan Composer:

    composer install
  5. Generate kunci aplikasi:

    php artisan key:generate
  6. Jalankan migrasi database untuk membuat skema tabel:

    php artisan migrate
  7. Jalankan server pengembangan:

    php artisan serve

    atau

     php -S localhost:{{port}} -t public

Proyek sekarang dapat diakses di http://localhost:{{port}}.

Kontribusi

Kami sangat menghargai kontribusi dari siapa pun untuk meningkatkan proyek ini. Jika Anda ingin berkontribusi, berikut adalah langkah-langkahnya:

  1. Fork repositori ini.
  2. Buat branch baru untuk fitur atau perbaikan Anda: git checkout -b {{nama-kamu}}.
  3. Lakukan perubahan yang diperlukan dan commit perubahan Anda: git commit -am '{{pesan commit}}'.
  4. Push ke branch yang Anda buat: git push origin {{nama-kamu}}.
  5. Buat pull request di repositori asli.

Library Tambahan yang Digunakan

  • Laravel - Framework PHP untuk pengembangan aplikasi web

Dokumen Tambahan

Dokumen tambahan seperti Entity Relationship Diagram (ERD) dan flowchart akan ditambahkan segera setelah tersedia.

About

Open source project to create starter backend using laravel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 76.4%
  • Blade 23.4%
  • JavaScript 0.2%