amayer5125/galley

为 CakePHP 提供简单的 Docker 开发环境

安装次数: 6,758

依赖项: 0

建议者: 0

安全性: 0

星标: 1

分支: 2

类型:cakephp-plugin

1.5.0 2023-09-28 17:19 UTC

This package is auto-updated.

Last update: 2024-09-12 06:04:08 UTC


README

为 CakePHP 开发提供一个小型 Docker 开发环境。

简介

Galley 为 CakePHP 提供一个兼容 macOS、Windows (WSL2) 和 Linux 的本地开发体验。使用 Galley 之前,除了 Docker 之外,不需要在您的本地计算机上安装任何软件或库。Galley 简单的 CLI 意味着您可以在没有任何 Docker 经验的情况下开始构建您的 CakePHP 应用程序。

灵感来源

Galley 受 Vessel 的启发,该工具由 Chris Fidao 开发,同时也借鉴了 Laravel Sail。如果您想深入了解 Docker,可以查看 Chris 的课程: Shipping Docker

安装

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。

安装 composer 包的推荐方法是

composer require --dev amayer5125/galley

接下来 在 src/Application.php 文件中加载插件

$this->addOptionalPlugin('Galley');

安装插件后,您可以通过运行以下命令来初始化 Galley

bin/cake galley install

这将在项目的根目录中创建一个 docker-compose.yml 文件。按照命令输出的说明进行操作后,您可以通过运行以下命令启动应用程序

vendor/bin/galley up -d

在浏览器中转到 https:// 并查看您的 CakePHP 网站!

可选设置

您可以选择配置 Bash 或 ZSH 别名,而不是反复输入 vendor/bin/galley 来执行 Galley 命令,从而使执行 Galley 的命令更加方便

alias galley="vendor/bin/galley"

使用方法

要获取支持命令和示例的列表,请运行

vendor/bin/galley --help

Xdebug 支持

Galley 默认支持 Xdebug。要启用它,请在与项目根目录相同的目录中创建一个名为 docker-compose.override.yml 的文件,并包含以下内容

services:
  app:
    environment:
      XDEBUG_MODE: "debug,develop"
    extra_hosts:
      - "host.docker.internal:host-gateway"

创建文件后,运行 galley up -d。Xdebug 应该现在已启用。

请确保 docker-compose.override.yml 文件被 git 忽略。