heyblackmagic/foundation

此包最新版本（3.1.1）没有可用的许可信息。

维护者

详细信息

github.com/wearealloy/foundation

源代码

问题

安装: 5

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:项目

3.1.1 2024-09-20 00:57 UTC

Requires

Requires (Dev)

Unknown License 1b3663e9b9d5365f36f8c765dc70f11dc9ed8ec4

This package is auto-updated.

Last update: 2024-09-20 01:00:03 UTC

README

Foundation 是一个用于 Craft CMS 5 的入门级项目，旨在简化开发流程。它是一个灵活且强大的基础框架，提供了基本的配置、模板和工具，以高效地启动 Craft CMS 项目。无论您是构建一个简单的网站还是一个复杂的应用程序，这个基础项目旨在节省时间和确保从一开始就遵循最佳实践。

特性

  • 预配置的 Craft CMS 5 环境。
  • 可定制的模板和组件。
  • 现成的开发环境配置。

要求

在安装此存储库之前，请确保以下工具已安装并正确配置

DDEV 全局设置

在安装 DDEV 或在安装此存储库之前，强烈建议您在 DDEV 中配置当前 git 设置。

运行以下命令

ln -s ~/.gitconfig ~/.ddev/homeadditions/.gitconfig

安装

您可能需要安装此存储库的情况有两种

从头安装

  1. 使用 Composer 的 create-project 命令创建项目
composer create-project heyblackmagic/foundation --no-install ./YOUR_PATH && cd YOUR_PATH
# Replace `YOUR_PATH` with the project directory path.
# The --no-install option in Composer prevents the installation step
# from running after the composer.lock file is updated
  1. 确保您处于为项目创建的目录中
cd ./YOUR_PATH
  1. 设置项目名称和其他 DDEV 配置选项。
ddev config --project-name=YOUR_PROJECT_NAME
# Replace YOUR_PROJECT_NAME with the name of your project.
  1. 启动项目
ddev start
  1. 安装 Craft CMS。 重要：在安装过程中，Craft CLI 将提示输入信息，如数据库凭据（名称、密码、用户和数据库驱动程序）或项目 URL。这些值已预先配置，不应进行编辑。
ddev craft install
# or
ddev craft install \
  --username="YOUR_USERNAME" \
  --email="YOUR_EMAIL@DOMAIN.COM" \
  --password="YOUR_PASSWORD" \
  --site-url='$DDEV_PRIMARY_URL'
  1. 使用 VSCode 打开项目。
ddev code

VSCode 可能会询问您是否要安装此存储库推荐的扩展。

VSCode recommended extensions notification

我们强烈建议安装建议的扩展。 您可以在此处查看建议扩展的完整列表。

如果 VSCode 未提示您关于建议的扩展，您可以通过前往扩展（shift + command + X）手动检查它们。在搜索栏中，通过“推荐”进行筛选。

VSCode extensions panel

此时，运行 ddev launch 或 ddev launch /admin 将在默认浏览器中打开您的项目 URL。

编码愉快！ 😊

从 git pull 安装现有项目

如果您是从 git pull 或 git clone 安装现有项目，请按照以下步骤操作。

  1. 从 GitHub 拉取或克隆项目。

  2. 为了避免在协作时环境之间的差异，请勿更改 DDEV 项目的名称。您对 repo 配置所做的任何更改都应与您的团队沟通。

  3. 启动项目。

ddev start
  1. 导入项目数据库。
ddev craft db/restore ./YOUR_DB_BACKUP_PATH
  1. 使用 VSCode 打开项目。
ddev code

VSCode 可能会询问您是否要安装此存储库推荐的扩展。

VSCode recommended extensions notification

我们强烈建议安装建议的扩展。 您可以在此处查看建议扩展的完整列表。

如果 VSCode 未提示您关于建议的扩展，您可以通过前往扩展（shift + command + X）手动检查它们。在搜索栏中，通过“推荐”进行筛选。

VSCode extensions panel

您现在可以继续开发现有项目了。

编码愉快！

关于命令的歧义解决

为了让DDEV能够在各自的环境中执行命令，你必须在每个命令前加上ddev前缀。例如，你应该输入ddev npm run dev而不是npm run dev。参考：常见问题解答，DDEV文档。

然而，当你运行ddev code命令时，VSCode会使用Dev Containers扩展打开项目，即直接打开Docker容器。这意味着项目中的任何操作都将处于docker / DDEV环境中，因此如果你在VSCode终端中运行命令，不需要在ddev前加前缀。

工作流程命令

  • ddev npm run dev：启动Vite开发服务器。
  • ddev npm run build：使用Vite编译JS和CSS。
  • ddev craft：创建控制台应用程序。

VSCode扩展

我们强烈推荐安装以下扩展以获得更好的开发体验

  • DEV Containers：Dev Containers扩展允许你将Docker容器作为功能齐全的开发环境使用。
  • EditorConfig for VSCode：此插件尝试使用在.editorconfig文件中找到的设置覆盖用户/工作区设置。
  • Prettier - 代码格式化工具：Prettier是一个有偏见的代码格式化工具。它通过解析你的代码并以它自己的规则重新打印它来强制执行一致的风格，这些规则考虑到最大行长度，并在必要时包装代码。
  • Tailwind CSS IntelliSense：Tailwind CSS IntelliSense通过为Visual Studio Code用户提供自动完成、语法高亮和代码检查等高级功能来增强Tailwind的开发体验。
  • Twiggy：Twiggy语言服务器为Twig提供语法高亮、自动完成和格式化。建议卸载其他任何Twig扩展。