gammamatrix / playground-matrix-resource

游乐场:提供与Playground Matrix(Laravel应用的项目管理系统)交互的API和Blade UI。

dev-develop / 73.x-dev 2024-08-18 06:48 UTC

This package is auto-updated.

Last update: 2024-09-18 07:46:13 UTC


README

Playground CI Workflow Test Coverage PHPStan Level 9 src and tests

这是 playground-matrix-resource Laravel包。

此包提供了与Playground Matrix(项目管理与任务系统)交互的API和Blade UI。

如果您只需要JSON API,则可以禁用Blade UI。

该应用提供了Swagger文档:swagger.json

  • 在Swagger编辑器中查看Playground Matrix Resource的swagger.json:
  • 端点模型支持锁定、强制删除垃圾、恢复等。
  • 索引端点支持高级查询过滤。

更多关于使用Playground Matrix Resource的信息,请参阅Read the Docs for Playground。

安装

您可以通过composer安装此包

composer require gammamatrix/playground-matrix-resource

关于

Playground通过artisan about命令提供信息。

screenshot of artisan about command with Playground Matrix Resource.

配置

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Playground\Matrix\Resource\ServiceProvider" --tag="playground-config"

默认情况下,所有路由都是启用的。它们可以通过环境变量或配置来禁用。

查看已发布的配置文件内容:config/playground-matrix-resource.php

您可以使用以下命令发布路由文件

php artisan vendor:publish --provider="Playground\Matrix\Resource\ServiceProvider" --tag="playground-routes"
  • 路由将发布在routes/playground-matrix-resource文件夹中

环境变量

如果您无法发布或不想发布此包的配置文件,您可以通过系统环境变量覆盖选项。

有关环境变量的信息可在该包的维基页面上找到

迁移

此包需要在playground-matrix Laravel包中执行迁移。

Cloc

composer cloc
➜  playground-matrix-resource git:(develop) ✗ composer cloc
> cloc --exclude-dir=node_modules,output,vendor .
     747 text files.
     441 unique files.
     308 files ignored.

github.com/AlDanial/cloc v 1.98  T=0.73 s (604.6 files/s, 92585.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                             3              0              0          23774
PHP                            304           3379           4899          20135
YAML                            92              5              0          13943
Blade                           36            159              7            865
XML                              3              0              5            223
Markdown                         2             37              0             86
INI                              1              3              0             12
-------------------------------------------------------------------------------
SUM:                           441           3583           4911          59038
-------------------------------------------------------------------------------

PHPStan

在以下级别进行9级测试

  • config/
  • database/
  • resources/views/
  • routes/
  • src/
  • tests/Feature/
  • tests/Unit/
composer analyse

编码标准

composer format

测试

composer test

变更日志

有关最近更改的更多信息,请参阅CHANGELOG