README

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

1DR.Starter.Project.mp4

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

composer create-project...

make install

make dev

显著特性

DDEV 用于本地开发
Vite 2.x 用于前端打包和HMR
Tailwind 3.x 用于实用CSS
Alpine 2.x 用于轻量级响应性
DeployHQ 用于自动化部署
Makefile 用于常见CLI命令

本地机器先决条件

Docker
DDEV，最低版本1.19
可选但推荐，Composer

入门

选项1：使用Composer（推荐）

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

打开终端提示，并运行

composer create-project springworks/craftcms PATH --no-install

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

选项2：使用Git CLI

您还可以通过Git CLI克隆仓库

git clone git@github.com:steverowling/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（在安装过程中稍后注意此信息）
文档根位置：默认为 web，保持不变
项目类型：默认为 php，保持不变

安装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 - 构建所有前端资源。
make composer xxx - 在容器中运行Composer命令，例如make composer install
make craft xxx - 在容器中运行Craft命令，例如make craft project-config/touch
make npm xxx - 在容器中运行npm命令，例如make npm install
make pull - 拉取远程数据库和资源（需要设置craft-scripts）

Craft CMS插件

Tailwind插件

JavaScript库

路线图

继续改进文档
错误修复，新功能

致谢与鸣谢

除了对Pixel & Tonic团队在Craft上的不懈工作的感激之情外，还要特别感谢nystudio107的Andrew Welch。他不仅开发了Craft生态系统中一些最广泛使用的插件，而且还投入了无数的时间和精力，推动我们这个社区的每个人在所做的一切上都取得卓越成就。他有一种非凡的能力，能够洞察开发战场的迷雾，知道什么是最优的——不仅对我们，而且对我们未来的自己、我们的客户以及我们构建的网站的用户都是如此。他的贡献使得我们所有的网站在SEO方面表现更好，在浏览器中运行更快，并使我们的开发工作流程更加流畅和高效。向您致敬，先生。

springworks / craftcms

维护者

详细信息