README

为每个pckg项目提供一个干净的开始。

功能

• PHP 8.0 框架，后端具有ORM、迁移、认证、队列和多语言模块 - pckg
• 前端Webpack与VueJS生态系统集成 - pckg-app/frontend 和 pckg-app/frontend-dev
• 适用于开发和生产环境的即插即用Docker镜像 - pckg/docker-images
• CI & CD流水线（Github Workflows） - ./github/workflows/
• PHP Cloc、Stan、CS、Codeception和Mocha - composer.json 和 package.json

开发环境

整个开发环境，包括系统依赖项和一些服务，都包含在schtr4jh/pckg:latest Docker镜像中。

$ docker run \
-v $PWD:/var/www/html \
-i -p 8072:443 \
-t schtr4jh/pckg:latest \
--restart=always /bin/bash

有关配置、参数和服务更多信息，请参阅pckg/docker-images。

创建项目

使用composer创建项目并安装所有依赖项（包括开发依赖项）。

# composer create-project pckg/skeleton . -s dev --prefer-dist

安装前端依赖项。

# yarn install

控制台

查看console提供的内容。

# php console

可用命令

help Displays help for a command list Lists commands\
app\
**app:create**        Create new application\
cache\
**cache:clear**       Clear cache\
migrator\
**migrator:install**  Install migrations from envirtonment\

创建新应用程序

为新的应用程序创建目录结构。

# php console app:create

回答一些问题并在app目录中创建新的应用程序结构。

初始化应用程序

为应用程序创建静态存储目录。

# php console project:init

这将创建storage文件夹，其中包含一些不在GIT中包含的必需子文件夹。

访问应用程序

在网页浏览器中打开。

https://:8072/

目录结构

• vendor、components 和 node_modules - 依赖管理器目录
• www - 将公开到互联网的目录
• storage - 框架、缓存、上传、tmp和其他私有和公共文件的目录
• config - 根项目配置
• app/$app/config - 应用程序配置
• app/$app/src - 应用程序源文件
• app/$app/public - 静态资源（私有，可以挂载到www）

注意：建议禁用依赖管理器目录、www 和 storage 的发现。

测试应用程序

运行mocha + codeception测试 + 静态代码分析。

# php console project:test

更多

后端

• pckg/framework - 了解应用程序生命周期、控制台访问、路由、请求、响应、模板和其他框架概念。
• pckg/database - 了解数据库和数据层组织
• pckg/migrator - 迁移您的数据库结构、数据和配置
• pckg/collection - 更多关于数据和集合操作的信息
• pckg/htmlbuilder - 更多关于表单和请求验证的信息
• pckg/manager - 更多关于资产和元数据管理的信息
• pckg/auth - 更多关于本地和远程认证选项的信息
• pckg/storage - 更多关于存储层的信息
• pckg/translator - 更多关于国际化层的信息
• pckg/queue - 更多关于队列层的信息
• pckg/locale - 更多关于本地化层的信息
• pckg/cache - 更多关于缓存层的信息
• pckg/httpql - 更多关于查询数据的信息
• pckg/mail - 更多关于邮件通信的信息
• pckg/websocket - 更多关于WebSocket服务器和客户端的信息
• pckg/tenant - 更多关于多租户支持的信息
• pckg/task - 更多关于异步任务处理的信息

前端

• pckg/helpers-less - 简单的前端LESS框架
• pckg/helpers-js - 前端Vue辅助工具
• pckg/orm - 简单的JavaScript对象关系映射（ORM）

更多

• pckg-app/demo-app - 具有功能展示的演示应用程序
• pckg/docker-images - Docker镜像

支持

pckg/framework pckg.org