README

介绍

Laravel Starter Base App Kit 是一个用于开始新 Laravel 项目的样板，预先配置了代码质量工具、环境配置和基本软件包。本套件旨在通过提供构建健壮且易于维护的 Laravel 应用程序的基础，简化开发过程。

安装

要使用此入门套件创建新项目，请运行以下命令

默认

composer create-project lightszentip/laravel-starter-base-app

jetstream

composer create-project lightszentip/laravel-starter-base-app:dev-jetstream

filamentphp

composer create-project lightszentip/laravel-starter-base-app:dev-filamentphp

设置

创建项目后，导航到项目目录并设置您的环境

cd laravel-starter-base-app
cp .env.example .env

运行数据库迁移和种子文件

php artisan migrate
php artisan db:seed

功能

• 预配置的代码质量工具：包括 Pint、Larastan、PHPMD、PSALM 和 PHPCodeSniffer。
• 环境配置：轻松设置环境变量。
• 基本软件包：预安装的安全、静态分析和更多软件包。

代码质量工具

此入门套件包含几个预配置的代码质量工具

• Pint：[Pint 工作流程](https://github.com/lightszentip/laravel-starter-base-app/blob/HEAD/./.github/workflows/pint.yml)
• Larastan：[Larastan 工作流程](https://github.com/lightszentip/laravel-starter-base-app/blob/HEAD/./.github/workflows/larastan.yml)
• PHPMD：[PHPMD 工作流程](https://github.com/lightszentip/laravel-starter-base-app/blob/HEAD/./.github/workflows/phpmd.yml)
• PSALM：[PSALM 工作流程](https://github.com/lightszentip/laravel-starter-base-app/blob/HEAD/./.github/workflows/psalm.yml)
• PHPCodeSniffer：[PHPCodeSniffer 工作流程](https://github.com/lightszentip/laravel-starter-base-app/blob/HEAD/./.github/workflows/phpcodesniffer.yml)

用法

运行代码质量工具

要运行代码质量工具，请使用以下命令

• Pint：./vendor/bin/pint
• Larastan：./vendor/bin/phpstan analyse
• PHPMD：./vendor/bin/phpmd app text phpmd.ruleset.xml
• PSALM：./vendor/bin/psalm
• PHPCodeSniffer：./vendor/bin/phpcs

环境配置

在 .env 文件中配置您的环境变量。以下是关键设置

• APP_NAME：应用程序名称。
• APP_ENV：应用程序运行的环境（本地、生产等）。
• APP_KEY：应用程序密钥（使用 php artisan key:generate 生成一个）。
• DB_CONNECTION：数据库连接类型（例如，mysql）。
• DB_HOST：数据库主机。
• DB_PORT：数据库端口。
• DB_DATABASE：数据库名称。
• DB_USERNAME：数据库用户名。
• DB_PASSWORD：数据库密码。

贡献

欢迎贡献！请提交一个拉取请求或打开一个问题来讨论您的想法。

许可证

本项目采用 MIT 许可证。有关详细信息，请参阅LICENSE 文件。

支持

如有任何问题或疑问，请在GitHub 仓库中创建一个问题。