README

A Craft CMS starter project using DDEV for local hosting and Vite for front-end bundling and HMR.

1DR.Starter.Project.mp4

☝️ 一个1分钟的视频演示，从零开始，在新的Craft安装中实现Vite HMR，只需3个CLI命令

composer create-project...

make install

make dev

显著特性

DDEV用于本地开发
Vite 4.x用于前端捆绑和HMR
Tailwind 3.x用于工具优先CSS
Alpine 3.x用于轻量级响应性
Makefile用于常见的CLI命令

本地机器需求

Docker
DDEV，至少版本1.19
可选但推荐，Composer

入门指南

选项1：使用Composer（推荐）

如果您在本地机器上安装了Composer，您可以使用create-project来拉取最新的标记版本。

打开终端提示符，并运行

composer create-project wuhhh/craft PATH --no-install

确保PATH是一个新或现有且为空的文件夹。

选项2：使用Git CLI

或者，您也可以通过Git CLI克隆仓库

git clone git@github.com:wuhhh/craftcms.git PATH

确保PATH是一个新的或现有且为空的文件夹。

接下来，您可能想要丢弃现有的/.git目录。在终端中运行

cd PATH
rm -rf .git

最后，清理并设置一些默认文件以供使用

cp .env.example .env
mv -f composer.json.default composer.json
mv -f .gitignore.default .gitignore
rm CHANGELOG.md && rm LICENSE.md && rm README.md

选项3：手动下载

将仓库的副本下载到您的本地机器，并将其移动到您希望项目运行的位置。类似于上面，然后您可能希望清理并设置一些默认文件以供使用。在终端中运行

cd PATH
cp .env.example .env
mv -f composer.json.default composer.json
mv -f .gitignore.default .gitignore
rm CHANGELOG.md && rm LICENSE.md && rm README.md

配置DDEV

注意：本节为可选。如果您只是想测试这个项目，请随意跳到下一节。⚡

要配置项目以在其他域名上运行而不是https://craftcms.ddev.site，请运行

ddev config

按照提示操作。

项目名称：例如，mysite将导致项目URL为https://mysite.ddev.site（在安装过程中稍后注意这一点）
Docroot位置：默认为web，保持不变
项目类型：默认为craftcms，保持不变

安装Craft

要安装一个干净的Craft版本，请运行

make install

按照提示操作。

此命令将

将您的本地SSH密钥复制到容器中（如果您正在设置craft-scripts，这将很有用）
启动您的DDEV项目
安装Composer
安装npm
一次性构建Vite
生成APP_ID并将其保存到您的.env文件中
生成SECURITY_KEY并将其保存到您的.env文件中
首次安装Craft，允许您设置管理员的账户凭证
安装所有Craft插件

完成过程后，键入ddev launch以在默认浏览器中打开项目。🚀

使用Vite进行本地开发

要开始使用Vite的开发服务器和HMR进行开发，请运行

make dev

此命令将

将您的本地SSH密钥复制到容器中（如果您正在设置craft-scripts，这将很有用）
启动您的DDEV项目
安装Composer
安装npm
一次性构建Vite
启动Vite开发服务器

打开浏览器到您的项目域名以验证 Vite 是否已连接。开始制作美丽的事物。❤️

Makefile

包含了一个 Makefile，以提供统一 CLI 对常用开发命令的支持。

make install - 运行一个完整的单次过程来设置项目并安装 Craft。
make up - 启动 DDEV 项目，确保已添加 SSH 密钥，并且已安装 npm & Composer。
make dev - 运行所有前端资源的单次构建，然后启动 Vite 的服务器以实现 HMR。
make build - 构建 all 前端资源。

Craft CMS 插件

JavaScript 库

AlpineJS

致谢与鸣谢

除了对 Pixel & Tonic 团队在整个团队在 Craft 上的不懈工作表示明显的感激之情外，还要特别感谢 nystudio107 的 Andrew Welch。[nystudio107](https://nystudio107.com/)。他不仅开发了 Craft 生态系统中一些最广泛使用的插件，而且投入了无数的时间和精力，推动我们所有人将每一件事都做到最好。他有一种超凡的能力，能够洞察开发战争的迷雾，知道什么是最好的——不仅对我们，而且对我们未来的自己、我们的客户和我们构建的网站的用户。他的贡献使我们的网站在 SEO 方面表现更好，在浏览器中运行更快，使我们的开发流程更加流畅和高效。向您致敬，先生。

wuhhh / craft

维护者

详细信息