leeroy/craft-starter-nuxt

Craft CMS 无头模式入门级项目,使用 DDEV 和 Nuxt 3 构建

v1.0.0 2023-03-10 19:11 UTC

This package is auto-updated.

Last update: 2024-09-10 22:35:23 UTC


README

使用 Nuxt 3 和无头 Craft CMS 运行的入门级项目

本地计算机先决条件

  1. Docker
  2. DDEV
  3. Composer

概览

Craft CMS

位于 backend 文件夹中,已预先配置为无头模式。
我们需要 Craft Pro 来使用 GraphQL。
请记得将您的部分添加到 GraphQL 的公共模式中。

Nuxt 3

位于 frontend 文件夹中。
已配置为使用 nuxt-graphql-client文档)从 Craft 获取数据。
使用 i18n文档)进行本地化。

使用此入门级项目创建新项目

  1. 打开终端提示,并运行
composer create-project leeroy/craft-starter-nuxt PATH --no-install
  1. 编辑 backend/.ddev/config.yaml 文件并更改 name(如果需要,还可以更改 php_versiondatabase)。
  2. 然后运行以下命令以安装 Craft 的纯净版本
make install
  1. 按照提示操作(DDEV 帮助填写了 .env 文件)

过程完成后,键入 make dev 以开始在该项目上进行开发。🚀

上述命令将自动执行以下操作

  1. 将您的本地 SSH 密钥复制到容器中
  2. 启动您的 DDEV 项目
  3. 安装 Composer
  4. 安装 yarn
  5. 生成 APP_ID 并保存到您的 .env 文件中
  6. 生成 SECURITY_KEY 并保存到您的 .env 文件中
  7. 首次安装 Craft,允许您设置管理员的账户凭证
  8. 安装所有 Craft 插件

在现有项目上进行开发

make dev

此命令将自动执行以下操作

  1. 将您的本地 SSH 密钥复制到容器中
  2. 启动您的 DDEV 项目
  3. 安装 Composer
  4. 安装 yarn
  5. 启动 Nuxt 服务器
  6. 输出 ddev describe 以显示项目域
  7. 打开浏览器(针对 MacOS 用户)

打开浏览器到您的项目域(例如 xxxx.ddev.site),以验证 Vite 是否已连接。开始制作美丽的事物。❤️

数据库

使用以下命令导出数据库

cd backend && ddev export-db > ./dumpfile.sql.gz

使用以下命令导入数据库

cd backend && ddev import-db < dumpfile.sql.gz

您还可以使用 DDEV 内置的 phpMyAdmin 进行数据库导入——但请注意,它要慢得多。

Makefile

Makefile 已包含以提供对常见开发命令的统一 CLI。

  • make install - 运行一次完整过程以设置项目和安装 Craft。
  • make boot - 启动 DDEV 项目,确保已添加 SSH 密钥,并已安装 npm 和 Composer。
  • make up - 运行 Craft 命令以清除缓存并加载 yaml 配置文件。它在运行任何 make dev 命令时也会执行。
  • make dev - 运行一次构建所有前端资产,然后启动 Vite 的服务器以进行 HMR。
  • make composer xxx - 在容器内运行 Composer 命令,例如 make composer install
  • make craft xxx - 在容器内运行 Craft 命令,例如 make craft project-config/touch

DDEV

使用 'ddev' 命令

确保同时没有其他东西正在运行(Apache 或其他基于 Docker 的环境)。
要关闭 Lando

lando poweroff