madebyshape/craft-3


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

在终端内,让我感到困惑的一点是,一旦运行了如make dev之类的CLI命令,该如何退出Vite。您不能像在正常终端中那样使用ctrl + c。您需要使用

q + enter

推荐使用HTTPS

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

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

路线图