README

Aplus 框架应用项目

入门

确保您已安装 Composer。

按照用户指南中的安装说明操作。

要安装最新版本

composer create-project aplus/app

或者，要安装最新 LTS 版本

composer create-project aplus/app:^22

进入项目目录。

可选地，您可以从此模板在 GitHub 上开始新的项目。

许可

添加 LICENSE 文件。

如果您考虑开源您的项目，选择一个许可证。

如果您的项目是专有的，您可以添加自定义许可证或不添加。

编辑 .php-cs-fixer.dist.php 文件。设置项目名称和版权信息。

要更新所有 PHP 文件中的注释头，运行

vendor/bin/php-cs-fixer fix -vvv

代码质量

Aplus 框架在其所有项目中使用代码质量工具。

默认情况下，App 项目也使用以下工具作为 dev-dependencies

静态分析

通过运行，您可以在不编写测试的情况下找到代码中的错误

vendor/bin/phpstan analyse

查看 phpstan.neon.dist 文件以获取更多详细信息。

代码检查器

通过运行，您可以在源代码中查找几个潜在问题

vendor/bin/phpmd app xml phpmd.xml

在 phpmd.xml 文件中自定义您的规则。

编码标准

我们扩展 PHP-CS-Fixer 来创建编码标准库。

它与 PSR-12 兼容。

通过运行，您可以看到源代码中需要修复的内容

vendor/bin/php-cs-fixer fix --diff --dry-run --verbose

测试

我们扩展 PHPUnit 来创建测试库。

通过运行，您可以单元测试您的代码

vendor/bin/phpunit

查看 phpunit.xml.dist 文件以获取更多详细信息。

文档

好的软件通常有好的文档。

您可以为您的项目文档构建美丽的 HTML 页面。

您必须在您的计算机上安装 phpDocumentor 或在容器内运行 phpdoc。

开发环境

App 项目附带 dev-dependency 以轻松配置内置的 PHP 开发服务器。

只需运行

vendor/bin/php-server

然后您的项目将在 https://:8080 上可用。

查看 php-server.ini 文件以获取更多详细信息。

容器

Aplus 提供用于测试和构建软件的 Docker 镜像。

您可以在 CI 或本地环境中运行它。

在您的计算机上安装了 Docker 之后，您就可以运行

docker-compose run --service-ports lempa

这将使您以 开发者 用户身份登录到一个Docker容器中，您可以在其中运行所有测试。

默认情况下，Web应用程序将在 https:// 的80和443端口上可用。

有关更多详细信息，请参阅 docker-compose.yml 文件。

持续集成

App项目是跨平台的，可以用于公共和私人项目。

您可以在 GitLab、在 GitHub、在您的计算机上，您想去的任何地方使用它。

App项目已经预先配置，可以在GitLab CI环境中运行。

有关更多详细信息，请参阅 .gitlab-ci.yml 文件。

只需将您的项目上传到GitLab，它就会运行管道。

在GitHub上，它将运行工作流程来测试您的代码，每次Push或Pull Request时。

查看 .github 文件夹以获取更多信息。

那么，接下来呢？

去构建一个API或一个网站，一个棒极了的应用程序！⚡

再见。

如果您有一点时间...

访问Aplus框架网站： aplus-framework.com

在以下平台关注Aplus：

关注我们的更新。

分享您关于与我们见面的经历！

记住:

编码是艺术。

编码是工程。

好的开发者喜欢编码。

用爱编码！

Aplus框架团队

aplus / app

维护者

详情