README

一个使用DDEV进行本地托管和Vite进行前端打包和HMR的Craft CMS入门项目。

1DR.Starter.Project.mp4

☝️ 一分钟视频演示，从零开始安装Craft，只需3个CLI命令即可实现Vite HMR。

composer create-project...

make install

make dev

显著特性

DDEV 用于本地开发
Vite 5.x 用于前端打包 & HMR
Tailwind 3.x 用于工具优先CSS
Alpine 3.x 用于轻量级响应性
Servd 作为默认托管环境
Postmark 用于电子邮件投递
Makefile 用于常见的CLI命令

本地机器需求

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

开始使用

选项1：使用Composer（推荐）

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

打开终端提示符，并运行

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

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

选项2：使用Git CLI

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

git clone git@github.com:onedarnleyroad/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，保持不变
项目类型：默认为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 pull - 拉取远程数据库和资源（需要设置craft-scripts）

Craft CMS插件

Tailwind插件

JavaScript库

路线图

继续完善文档
错误修复，新功能

致谢与感谢

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

onedarnleyroad / craftcms

维护者

详细信息