madebyshape/craft-cms


README

Craft CMS 5 Starter

这是一个 Craft CMS 5.x starter MadeByShape 在内部项目中使用,现在开源了,任何人都可以使用。

技术栈

要求

功能

  • 模板
    • 带有全局页眉和页脚的布局模板设置就绪
    • 404、离线/维护和通用错误异常模板
    • 用于矩阵字段的页面模板设置
    • 用于发送更美观的系统电子邮件(忘记密码等)的电子邮件模板
  • 配置
    • 所有 Craft CMS 插件的配置
    • 自定义的通用配置,具有所需的功能,并连接到 .env 变量
  • 环境
    • 包含 Servd 和 Mailgun 的自定义 .env 文件
  • 构建
    • HMR
    • CSS 和 JS 压缩并清除
    • 生成并自动将 Favicon 插入模板中
    • 图像压缩
    • 生成源映射
  • Servd
    • 设置以用于 Servd 托管平台
    • 启用使用静态缓存
  • 缓存
    • 使用 Blitz 处理服务器缓存和预热

插件

Craft CMS

  • Blitz
  • Hyper
  • SEOMatic
  • Vite
  • Sprig
  • Formie
  • Imager X
  • 压缩
  • CKEditor
  • Mailgun
  • Servd 资产存储

Tailwind CSS

  • 宽高比

安装

在终端中创建一个空文件夹并 CD 到它(如果您计划使用选项 1 或 2)。

1a. 选项 1:Composer

如果您已安装本地的 composer,请打开终端并运行

composer create-project madebyshape/craft-cms

1b. 选项 2:Git

您可以使用 Git CLI 从 Github 克隆存储库

git clone git@github.com:madebyshape/craft-cms.git

1c. 选项 3:手动

使用上面的 Code 按钮,选择 Download ZIP 下载此存储库的副本到您的计算机。将这些文件移动到您的空文件夹中。

2. 启动 DDEV,安装 Craft CMS 和依赖项

首先,编辑 .ddev/config.yaml 并将 name 更改为您的项目名称。

然后,我们创建了一些 CLI 命令(更多),允许您启动 DDEV、安装 Craft CMS 和安装依赖项(Node 尤其是)。开始的一步

make install

3. 启动 Vite

一旦您按照步骤 2 操作并成功运行了步骤,您将需要启动 Vite,这将允许您开始使用前端工具

make dev

CLI 命令

我们创建了一些命令,使开发更容易。所有这些命令都在终端中运行

值得了解

数据库

要在DDEV环境中访问数据库,您可以使用TablePlus。您可以使用以下命令打开TablePlus进行导出/导入:

ddev tableplus

退出Vite

在终端中,有一件事让我感到困惑,那就是如何在运行CLI命令(如make dev)后退出Vite。您不能像在正常终端中那样使用ctrl + c。您需要使用

q + enter

推荐使用HTTPS

在HTTP上使Vite、DDEV和Craft CMS良好协同运行存在一些问题,因此请始终确保您正在使用HTTPS。对于DDEV,只需运行

ddev stop --all
mkcert -install
ddev start
ddev launch

路线图