thecoati/surf

运行基本 Radicle 应用的 Docker 文件。

资助包维护!
TheCoati

安装: 6

依赖: 0

建议者: 0

安全: 0

星星: 4

关注者: 2

分支: 2

类型:项目

dev-develop 2023-04-10 23:12 UTC

This package is auto-updated.

Last update: 2024-09-11 02:21:28 UTC


README

Radicle Surf 是对 Laravel Sail 进行修改,使其与 Radicle 兼容。

注意
Radicle Surf 目前仍在开发中。
目前只添加了 MySQL 服务。

目录

简介

Radicle Surf 是一个轻量级的命令行界面,用于设置基于 Laravel Sail 的 Radicle Docker 开发环境。Surf 提供了一个很好的起点,用于使用 PHP、MySQL 和 Redis 构建 Radicle 应用程序,无需具备先前的 Docker 经验。

本质上,Surf 是存储在项目根目录的 docker-compose.yml 文件和 surf 脚本。该 surf 脚本提供了一套方便的 CLI 方法,用于与由 docker-compose.yml 文件定义的 Docker 容器进行交互。

Radicle Surf 支持 macOS、Linux 和 Windows(通过 WSL2)。

安装 & 设置

您可以使用 Composer 包管理器安装 Surf。当然,这些步骤假设您的现有本地开发环境允许您安装 Composer 依赖项

composer require thecoati/surf --dev

安装 Surf 后,您可以使用 surf install 命令。此命令将 Surf 的 docker-compose.yml 文件发布到应用程序的根目录

./vendor/bin/surf install

最后,您可以启动 Surf。

./vendor/bin/surf up

配置 Shell 别名

默认情况下,Surf 命令是通过 vendor/bin/surf 脚本来调用的

./vendor/bin/surf up

但是,您可能希望配置一个 Shell 别名,以便更容易地执行 Surf 命令,而不是反复键入 vendor/bin/surf 来执行 Surf 命令

alias surf='[ -f surf ] && sh surf || sh vendor/bin/surf'

为了确保它始终可用,您可以将此添加到您的家目录中的 Shell 配置文件中,例如 ~/.zshrc~/.bashrc,然后重新启动您的 Shell。

一旦配置了 Shell 别名,您就可以通过简单地键入 surf 来执行 Surf 命令。本文档的其余示例将假设您已配置此别名

surf up