viget / craft-site-starter
5.0.1
2024-05-31 18:50 UTC
Requires
- craftcms/aws-s3: 2.2.1
- craftcms/ckeditor: 4.0.6
- craftcms/cms: ^5.0.0
- mmikkel/cp-field-inspect: 2.0.1
- nystudio107/craft-emptycoalesce: 5.0.0
- nystudio107/craft-retour: 5.0.0
- nystudio107/craft-seomatic: 5.0.3
- nystudio107/craft-vite: ^5.0.0
- spacecatninja/imager-x: 5.0.0
- verbb/navigation: 3.0.0
- viget/craft-classnames: 3.0.0
- vlucas/phpdotenv: ^5.4.0
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/generator: ^2.0.0
- craftcms/phpstan: dev-main
- nystudio107/craft-autocomplete: ^1.12
- yiisoft/yii2-shell: ^2.0.3
This package is auto-updated.
Last update: 2024-09-27 00:08:54 UTC
README
此仓库是一个用于与 composer create-project
命令一起使用的 Composer "项目"。
我们的启动器使用 DDEV 进行本地开发。在执行以下任何步骤之前,请先安装它。
功能
- 本地开发 由 DDEV 驱动
- Vite 基于的前端构建工具。
- 自动代码风格检查、格式化和类型检查
- 通过 Husky 在 git 预提交钩子上运行
- 仅使用 lint-staged 处理暂存文件
- Prettier, eslint, PHPStan, PHP Easy Coding Standard
- 预装常见插件
- 本地邮件通过 Mailpit 路由(永远不用担心向客户或用户发送邮件)
入门指南
创建项目
-
选择项目文件夹并进入其中
cd /path/to/web/projects mkdir my-project cd my-project
-
创建项目 如果您已经在主机计算机(您的计算机,而不是 Docker 容器或 DDEV 实例)上运行 PHP 和 Composer,您可以运行以下命令
composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs
如果您不想设置 PHP,可以使用可丢弃的 Docker 镜像创建项目(感谢 nystudio107)。
docker run --rm -it -v "$PWD":/app -v ${COMPOSER_HOME:-$HOME/.composer}:/tmp composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs
-
启动 DDEV & 安装 Craft
ddev start ddev craft install
-
运行
ddev launch
在浏览器中打开项目
插件
此启动器包含我们在大多数网站上使用的常见插件。这为客户端项目提供了一致性和熟悉感。您可能不需要每个插件,但请避免用类似替代品替换标准插件(除非绝对必要)。
为此启动器做出贡献
本地开发
理想情况下,您应该能够轻松地克隆此存储库并修改插件和构建工具配置。
运行 ddev start
并在功能分支中进行编辑。
有关技术目标和决策的详细信息,请参阅 ARCHITECTURE.md