flightphp/skeleton

A Flight PHP 框架骨架应用,帮助您的项目快速启动并运行

v0.4.1 2024-06-29 22:47 UTC

This package is auto-updated.

Last update: 2024-08-29 23:12:01 UTC


README

使用此骨架应用快速设置并开始开发新的 Flight PHP 应用程序。此应用程序使用 Flight PHP v3 的最新版本。

此骨架应用是为 Composer 构建的。您还可以下载此存储库的 zip 文件,下载 flightphp/core 存储库的 zip 文件,并在您的 app/config/bootstrap.php 文件中运行 require('flight/autoload.php') 以手动加载文件。

安装

从您想安装新 Flight PHP 应用的目录中运行此命令。(这需要 PHP 7.4 或更高版本)

composer create-project flightphp/skeleton cool-project-name

cool-project-name 替换为您新应用的期望目录名称。

在您创建项目后,确保您前往 app/config/config.phpapp/config/services.php,在开始之前取消注释您想使用的数据库相关的行。

注意:如果您使用 PHP 8.0 或更高版本并想使用 tracy-extensions,请确保在项目创建后运行 composer require --dev flightphp/tracy-extensions "^0.2"

应用程序的强大设置

此骨架将包含两种启动应用的版本。强大版本是一个完全结构化的应用,适用于预期规模较大的项目。考虑到面向对象编程,使其更容易进行单元测试和与多个开发者(或自己)一起扩展项目。

强大版本添加了一个 app/ 目录,其中所有内容都具有基本结构。这是此骨架默认配置的方式。

应用程序的简单设置

这是一个基本的单文件应用。唯一的例外是配置文件,它仍然位于 app/config/ 目录中。这是一个很好的起点,适用于较小的项目或您不预期会增长太多的项目。

要使用简单版本,您需要将 index-simple.php 文件移动到 public/ 目录,并将其重命名为 index.php。您可以删除任何其他控制器、视图或配置文件(当然不包括 config.php 文件)。

在简单设置中,有两个非常重要的安全步骤需要注意。

  • 请勿将敏感凭证保存在 index.php 文件中.
  • 请勿将任何类型的敏感凭证提交到您的存储库.

这就是配置文件的作用。如果您需要保存敏感凭证,请将它们保存到配置文件中,然后在 index.php 文件中引用它们。

运行应用程序

无依赖设置

要开发环境中运行应用程序,您可以运行以下命令

cd cool-project-name
composer start

之后,在浏览器中打开 http://localhost:8000

注意:如果您遇到类似此错误 Failed to listen on localhost:8000 (reason: Address already in use),则需要更改应用程序运行的端口。您可以通过编辑 composer.json 文件并更改 scripts.start 键中的端口来完成此操作。

Docker 设置

您可以通过 安装 Docker 并使用 docker-compose 通过 docker 运行应用,因此您可以运行以下命令

cd cool-project-name
docker-compose up -d
# or if a newer version of docker
docker compose up -d

之后,在浏览器中打开 http://localhost:8000

Vagrant 设置

您可以安装 Vagrant 以及像 VirtualBox 这样的提供者,并运行以下命令来启动一个已根据 n0nag0n/firefly 设置好的 PHP/MariaDB 环境。

cd cool-project-name
vagrant up

之后,在浏览器中打开 http://localhost:8000

动手做吧!

就这样!去创造一些非常棒的东西吧!