maymeow / cakephp-starter-kit
CakePHP 开发套件
Requires
- php: >=8.1
- cakephp/cakephp: ^4.4
- cakephp/migrations: ^3.0
- cakephp/plugin-installer: ^1.3
- maymeow/cakephp-service-layer: ^2.1
- mobiledetect/mobiledetectlib: ^2.8
Requires (Dev)
- cakephp/bake: ^2.3
- cakephp/cakephp-codesniffer: ~4.2.0
- cakephp/debug_kit: ^4.4
- josegonzalez/dotenv: ^3.2
- maymeow/sail: dev-main
- phpstan/phpstan: ^0.12.99
- phpunit/phpunit: ~8.5.0 || ^9.3
- psy/psysh: @stable
Suggests
- dereuromark/cakephp-ide-helper: After baking your code, this keeps your annotations in sync with the code evolving from there on for maximum IDE and PHPStan/Psalm compatibility.
- markstory/asset_compress: An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.
- phpstan/phpstan: PHPStan focuses on finding errors in your code without actually running it. It catches whole classes of bugs even before you write tests for the code.
This package is auto-updated.
Last update: 2024-09-20 21:22:18 UTC
README
开发套件包含
- Docker (Linux) 或 Docker Desktop (Mac 或 Windows)
- CakePHP 4.4.1 应用程序骨架
- 基于 Bootstrap 5.0 的主题插件 [WIP]
- 预定义的开发 Docker 环境 (CkePHP, PostgreSQL, Redis)
- 准备用于生产部署的 Docker 配置 (CakePHP, NGiNX, PostgreSQL, Redis),您还可以启用 traefik。
您的开发环境
在 docker-compose.dev.yml
中包含的用于开发环境的服务
安装
有更多不同的方式可以使用此项目作为您新应用程序的模板。您可以使用 推荐 的脚本下载模板
curl https://raw.githubusercontent.com/MayMeow/cakephp-starter-kit/main/create -o create-app chmod +x create-app sudo mv create-app /usr/local/bin/
然后您可以使用 create-app <您的应用名称>
创建您的应用程序。
或者您可以克隆此项目
git clone --depth=1 --branch=main https://github.com/MayMeow/cakephp-starter-kit.git app_name cd app_name rm -rf .git # then initialize new git repository with git init and set your remotes
或者使用 composer
composer create-project --prefer-dist maymeow/cakephp-starter-kit:dev-main app_name
cd app_name
或者使用 Docker
mdkir app_name cd app_name docker run --rm --volume $(pwd):/app ghcr.io/maymeow/php-ci-cd/php-ci-cd:8.0.2-cs-git sh -c "composer create-project --prefer-dist maymeow/cakephp-starter-kit:dev-main /app" sudo chown -R $USER:$GID .
配置
应用程序将自动为每个安装和构建生成安全密钥。这对于开发是可行的,但不适用于生产。建议您手动生成密钥,如下所示
docker-compose -f docker-compose.dev.yml run --rm cake-app php bin/cake.php generate_security_key
当您拥有密钥时,请复制它并更新 .env.production
文件,并将密钥粘贴到 SECURITY_SALT=
后面,不要加任何引号。
接下来,更新 DB_USER
、DB_NAME
、DB_PASSWORD
、POSTGRES_PASSWORD
、POSTGRES_USER
和数据库 POSTGRES_DB
。其他变量已预配置,如果您未更改 docker compose 文件中的值,则可以正常使用。
启用调试模式
为了开发,您可以在 .env.production
文件中将 DEBUG=true
设置为启用调试模式。强烈建议在生产环境中禁用调试模式
控制台
要访问控制台,请使用以下命令
docker-compose -f docker-compose.dev.yml run --rm cake-app php bin/cake.php
当您需要访问 Redis 控制台时,您可以使用以下命令
从 Redis 缓存数据库中获取所有键
docker exec -it cake_redis redis-cl # keys *
问题、新功能
如果您发现了问题或想提供反馈,或者您有新功能的想法。请使用 github 项目的 问题选项卡。
支持
如果您想支持开发,您可以使用此项目右侧面板中的资助按钮。或者如果您想帮助开发此项目,请给我发邮件(您可以在我的个人资料中找到地址)并在我的 GitLab 实例上为您创建账户。
许可证
MIT