README

项目描述

安装

在运行此项目之前，请确保使用的PHP版本至少为8.2。

以下是设置项目的步骤：

• 克隆此存储库

  git clone https://gitlab.com/venturo-web/venturo-laravel-skeleton.git
  

• 进入项目目录

  cd venturo-laravel-skeleton
  

• 使用以下命令安装laravel依赖项

  composer install
  

• 使用以下命令将.env.example复制为.env

  cp .env.example .env
  

• 生成laravel密钥

  php artisan key:generate
  

• 配置数据库：根据文件.env中的数据库配置进行设置

  DB_CONNECTION=mysql
  DB_HOST=127.0.0.1
  DB_PORT=3306
  DB_DATABASE=core_laravel_11_venturo
  DB_USERNAME=root
  DB_PASSWORD=
  

• 生成数据库和种子文件

  php artisan migrate --seed
  

• 生成JWT令牌

  php artisan jwt:secret
  

• 运行laravel项目

  php artisan serve
  

提交前的命令

在提交代码前，请确保运行以下命令，以确保代码与设定的标准保持一致

vendor/bin/pint

文件夹结构

.
├── App
│   ├── Exports : Menyimpan class helper untuk proses Export excel
│   ├── Imports : Menyimpan class helper untuk proses Import excel
│   ├── Mail : Menyimpan class helper untuk mengirim email
│   ├── Models : Menyimpan class model yang terhubung ke suatu tabel di database, Tempatkan tugas komunikasi dengan database (query database) melalui model
│   └── Http
│       ├── Controllers
│       │   ├── Api : Menyimpan class controller khusus untuk rest api
│       │   └── Web : Menyimpan class controller web frontend/selain rest api
│       ├── Helpers : Menyimpan class Helper/Sub function pembantu agar function utama pada controller tidak terlalu komplek, biasanya algoritma/manipulasi array ditempatkan di sini
│       ├── Middleware : Menyimpan class Middleware (Hanya lead programmer yang boleh menambahkan middleware)
│       ├── Request : Menyimpan class Form Request
│       ├── Resource : Menyimpan class Resource
│       └── Services : Menyimpan class Service
├── config : Directory untuk menyimpan semua konfigurasi
├── database : Directory untuk menyimpan Database Migration Script
├── public : Directory public yang digunakan sebagai root directory
├── views
│   ├── layout : save page/komponen untuk layouting, misalnya header/footer/sidebar/etc
│   ├── component : Menyimpan halaman/komponen yang bisa di recycle
│   ├── content
│   ├── email : Menyimpan file format html untuk pengiriman email
│   ├── excel : Menyimpan file format html ketika generate/download file excel
│   └── pdf : Menyimpan file format html ketika generate/download pdf
├── routes
│   ├── api.php : File untuk mendaftarkan routing API
│   └── web.php : FIle untuk mendaftarkan routing non API/Web biasa
├── storage
│   ├── app : Menyimpan file-file yang diupload & digunakan oleh pengguna
│   └── logs: Menyimpan log error yang di generate otomatis oleh laravel
├── tests : Menyimpan file / class untuk PHP unit test
├── .env : File environment untuk menyimpan konfigurasi pada masing-masing device development (Jangan dipush ke repository)
├── .env.example : File environment yang digunakan sebagai template .env (Wajib di push ke repository dan nama variabel harus di update menyesuaikan perubahan pada file .env) agar semua tim bisa mengetahui konfigurasi apa saja yang dibutuhkan.
├── .gitignore : File untuk mendaftarkan folder / file apa saja yang tidak push ke repository
└── composer.json : File untuk menyimpan daftar library apa saja yang digunakan