webfactor/laravel-backpack-documents

准备好使用带有API路由的Documents Backpack CRUD,例如隐私声明、版权信息、sbt或gtc

2.0.0 2019-07-11 10:35 UTC

This package is auto-updated.

Last update: 2024-09-11 21:39:09 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

准备好使用带有API路由的Documents Backpack CRUD,例如隐私声明、版权信息、sbt或gtc。

安装

通过Composer

$ composer require webfactor/laravel-backpack-documents

发布供应商文件

$ php artisan vendor:publish --provider="Webfactor\Laravel\Backpack\Documents\DocumentsServiceProvider"

运行迁移

$ php artisan migrate

[可选但推荐] 将菜单项添加到您的 sidebar.blade.php

<li>
  <a href="{{ url(config('webfactor.documents.backend.route_prefix').'/'.config('webfactor.documents.backend.route')) }}">
    <i class="fa fa-file-o"></i>
    <span>{{  trans('webfactor::documents.entity_name_plural') }}</span>
  </a>
</li>

使用方法

在发布的配置文件中定义您的文档类型。不要忘记在翻译文件中添加适当的翻译。

后端

前往定义的路由(默认:wfcms/document)并编辑您的文档,就像在Backpack CRUD中一样

API

向API路由发送GET请求(默认:api/v1/documents)。

如果您使用翻译,可以将lang参数附加到API路由以获取指定的语言。(例如,api/v1/documents?lang=de)

定制化

您可以根据需要编辑功能的多部分。只需查看发布的配置文件(《config/webfactor/documents.php》)。

如果要覆盖默认路由,请创建一个路由文件在《routes/webfactor/documents.php》并定义您的路由。

有关使用翻译的更多信息,请检查已安装的spatie/laravel-translatable版本。

变更日志

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

测试

$ composer test

贡献

请参阅CONTRIBUTINGCODE_OF_CONDUCT以获取详细信息。

安全性

如果您发现任何安全问题,请通过电子邮件oliver.ziegler@webfactor.de而不是使用问题跟踪器来报告。

致谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件