README

用于在Craft CMS中创建XM Media的新项目。

设置新网站

创建新项目

composer create-project xm/starter_craft project-name --stability=dev --no-install --remove-vcs

更新composer.json： name、license（可能是private）和description
更新package.json：name、version、git.url、license、private、script.dev-server
设置开发服务器
1. 如果使用InterWorx，上传setup_dev.sh并运行：sh ./setup_dev.sh
2. 上传文件（排除像node_modules和.env这样的操作系统相关文件，或者像.idea和.git以及.gitignore中许多内容，或者仅用于编辑的文件）。
3. 安装Composer（如果尚未安装）
4. 安装PHP包/供应商：php composer.phar install
5. 添加.env（复制.env.example并更新）。
6. 运行. ./node_setup.sh（这将设置node并安装JS包 - 需要已安装yarn）。
7. 运行yarn dev或yarn build（用于生产）以编译JS和CSS文件。
8. 为bin目录赋予可执行权限：chmod u+x craft
9. 安装Craft：./craft install/craft
删除或更新LICENSE文件。
本地安装Composer（如果未全局安装）。
本地Composer安装和更新：composer install && composer update
本地运行yarn && yarn upgrade。
上传composer.lock和yarn.lock，然后在服务器上运行php composer.phar install和. ./node_setup.sh再次。
查找并在整个网站中靠近@todo-craft注释处进行更改。所有更改的文件都需要上传到服务器。
创建新的favicon：realfavicongenerator.net
将图标/标志作为SVG添加到/storage/rebrand/icon/和/storage/rebrand/logo/中的logo.svg。（SVG最好。）仅适用于Craft的付费版本。
删除启动器文件：README.md（或更新）和TEMPLATES.md。
更新网站名称
- 在设置 -> 一般
- 在设置 -> 网站
- 全局 -> 网站信息

开发网站可通过https://[域名]/访问
Craft管理位于/admin

系统要求

PHP 8.1+
MySQL 5.7+
Node 14
Yarn

命令

生产JS/CSS构建：yarn build
开发JS/CSS构建：yarn dev
开发JS/CSS监视：yarn watch（文件将不会进行版本控制）
开发JS/CSS HMR服务器：yarn dev-server（见下文）
JS测试（《Jest》）：yarn test:unit
E2E测试（《Cypress》）：yarn test:e2e
代码风格检查
- JS（《ESLint》）：yarn lint:js或yarn lint:js:fix
- CSS：yarn lint:css或yarn lint:css:fix
PHP测试（《PhpUnit》）
- composer test
- 无内存限制 php -d memory_limit=-1 bin/simple-phpunit
- 带有覆盖率（HTML） composer test:coverage
PHP CS：必须先安装
- 模拟运行： composer cs
- 修复： composer cs:fix
PHP 静态分析 (PHPStan)： composer static

集成库和工具

前端 - 依赖项的完整列表可以在 package.json 中找到
- Vue - 前端框架
  - Vue Router - 前端路由包
  - Vuex - 帮助管理状态
  - Vue Devtools - 使浏览器中的调试更容易
  - Vue 模板 - .vue 文件的语法
  - Vue Test Utils - 帮助测试 Vue 组件
- Vue CLI - 管理和运行前端编译及测试
- SASS - CSS 预处理器（使用 node-sass）
- Webpack - 编译 JS 和 CSS
  - Babel - 将 JS 转换为所有浏览器都可以工作
  - Webpack Encore - 连接前端和后端并简化 Webpack 配置
  - PostCSS - 转换 CSS
  - Autoprefixer - 添加浏览器前缀
  - Purge CSS - 在部署过程中删除未使用的 CSS（开发时不运行）
  - SVGO - 优化 SVG 文件
  - Bundle Analyzer - 显示 JS 包的大小和统计信息
- Tailwind - 以工具优先的样式框架
- Jest - JS 单元测试
- Cypress - 端到端（e2e）测试
- Lodash - JS 的辅助函数
- date-fns - JS 日期的辅助函数
- PortalVue - 帮助管理如模态框等元素
- Vue-JS-Modal - 用于模态框
- Faker.js - 用于测试中生成假数据
- ESLint - 检查 JS 的约定和错误
- Stylelint - 检查 CSS 的约定和错误
后端 - 依赖项的完整列表可以在 composer.json 中找到
- Symfony - 后端框架
- Twig - 服务器端模板语言（有限使用）
- PhpUnit – 用于运行PHP测试
- PHP CS – PHP代码规范分析器及修复工具
- PHPStan – PHP静态分析工具
- Postmark – 用于发送电子邮件，包含电子邮件模板（目前设置在XM Media的账户下）
GitLab – 部署工具
开发工具
- Vue Devtools

xm / starter_craft_3

维护者

详细信息

README

设置新网站

系统要求

命令

集成库和工具