README

这是一个Craft CMS的脚手架包，由Statik.be提供。我们内部使用它来启动新项目。

做出的假设

我们假设了一些事情

• 我们使用Ddev作为我们的本地开发环境。

• 我们使用Postmark进行电子邮件投递。

• 我们使用TailwindCSS进行前端构建。

🛠 使用方法

在开始之前，请确保已安装Ddev并且您的docker-engine正在运行。否则，安装过程将在初始化时失败。

使用以下命令设置新项目

composer create-project statikbe/craft PATH

➡️ 将创建一个Craft CMS项目。接下来Craft会要求开始设置

   ______ .______          ___       _______ .___________.
  /      ||   _  \        /   \     |   ____||           |
 |  ,----'|  |_)  |      /  ^  \    |  |__   `---|  |----`
 |  |     |      /      /  /_\  \   |   __|      |  |
 |  `----.|  |\  \----./  _____  \  |  |         |  |
  \______|| _| `._____/__/     \__\ |__|         |__|

     A       N   E   W       I   N   S   T   A   L   L
               ______ .___  ___.      _______.
              /      ||   \/   |     /       |
             |  ,----'|  \  /  |    |   (----`
             |  |     |  |\/|  |     \   \
             |  `----.|  |  |  | .----)   |
              \______||__|  |__| |_______/


Generating an application ID ... done
Generating a security key ... done

Welcome to Craft CMS!

Are you ready to begin the setup? (yes|no) [yes]

➡️ 接下来将提出以下问题

• 您正在使用哪种数据库驱动程序？（mysql或pgsql）
• 数据库服务器名称或IP地址 [127.0.0.1]
• 数据库端口 [3306]
• 数据库用户名 [root]
• 数据库密码
• 数据库名称
• 数据库表前缀

➡️ 使用Craft建议的上述默认值，将允许您连接到您的Ddev数据库，并继续安装。

• 现在安装Craft？ [yes]
• 电子邮件
• 密码
• 确认
• 站点名称 [NL]
• 站点URL [@baseUrl/nl]
• 站点语言 [nl-BE]

➡️ Craft已安装，插件已安装，并应用了现有项目配置！ 🚀

现在我们准备好启动Statik设置了

cd PATH

ddev craft statik/setup

➡️ 这将为您提供以下选项/询问以下问题

       _______.___________.    ___   .___________.__   __  ___
        /       |           |   /   \  |           |  | |  |/  /
       |   (----`---|  |----`  /  ^  \ `---|  |----|  | |  '  /
        \   \       |  |      /  /_\  \    |  |    |  | |    <
    .----)   |      |  |     /  _____  \   |  |    |  | |  .  \
    |_______/       |__|    /__/     \__\  |__|    |__| |__|\__\

       A     N  E  W     C  R  A  F  T     P  R  O  J  E  C  T

• 输入新的系统名称
• 您想从Craft中移除前端账户流程吗？

如果您继续，以下部分将被移除： confirmAccount, editPassword, editProfile, forgotPassword, forgotPasswordConfirmation, login, profile, register, registrationCompleted, setPassword, setPasswordConfirmation

• 您想使用Postmark进行电子邮件传输吗？（yes|no）
  • 输入Postmark API密钥
• 输入用于测试预发布环境的电子邮件地址
• 您想为该项目设置一个git repo吗？（yes|no）
  • 添加远程仓库？
• 您想初始化git-flow吗？（yes|no）

➡️ 安装准备就绪！

🎨 前端设置

我们使用tailwindcss和vite.js

• vite.config.js
• tailwind.config.js

入门

[optional] nvm install
yarn install

之后，您可以使用以下命令进行构建

yarn dev

或

yarn watch

CSS和JavaScript

tailoff/css和tailoff/js

favicon 在tailoff/img/中添加一个名为favicon.svg的svg文件，并运行

yarn favicon

图标 图标放在tailoff/icons文件夹中

🧪 测试

前端栈中添加了两个测试。一个是使用pa11y-ci（在内部）的A11y测试器。还有一个是我们自己编写的html测试器，灵感来自pa11y代码，它使用html-validate（在内部）。您可以使用以下命令调用它们

$ yarn test-a11y
$ yarn test-html

它们都使用来自 .env 文件的 BASE_URL 变量来获取网站地图。这个网站地图被解析以获取网站中所有 URL 的列表。然后在这些 URL 上执行测试。

注意 要在您的本地系统上运行测试器，请在您的终端中运行以下命令

export NODE_EXTRA_CA_CERTS="$(mkcert -CAROOT)/rootCA.pem"

⚙️ 开发

要在这个仓库中工作，您可以像克隆常规项目一样克隆它

git clone git@github.com:statikbe/craft.git craft

⭐️ 特性与支持

我们很乐意听取您的建议并审查您的拉取请求，但请注意，这个仓库首先是用于内部项目的。