webfactor/laravel-backpack-documents

Ready to use Documents Backpack CRUD with API route for eg. privacy statement, imprint, sbt or gtc

LaravelBackpackDocuments

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Ready to use Documents Backpack CRUD with API route for eg. privacy statement, imprint, sbt or gtc., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require webfactor/laravel-backpack-documents, <sub>(*4)</sub>

Publish the vendor files

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

Run the migration, <sub>(*5)</sub>

``` bash $ php artisan migrate, <sub>(*6)</sub>

\[optional but recommended\] add a menu item to your `sidebar.blade.php`

``` html
<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>

Usage

Define your document types in the published config file. Don't forget to add appropriate translations in the translation files., <sub>(*7)</sub>

Backend

Go to the defined route (default: wfcms/document) and edit your documents like in Backpack CRUD, <sub>(*8)</sub>

Api

Send a GET-request to the api route (default: api/v1/documents)., <sub>(*9)</sub>

If you use translation you can append lang parameter to the api route to get the specified language. (eg. api/v1/documents?lang=de), <sub>(*10)</sub>

Customisation

You can edit many parts of the functionality. Just look at the published config file (config/webfactor/documents.php)., <sub>(*11)</sub>

If you want to overwrite the default routes, please create a route file at routes/webfactor/documents.php and define your routes there., <sub>(*12)</sub>

For using translations check the installed version of spatie/laravel-translatable for more information., <sub>(*13)</sub>

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*14)</sub>

Testing

bash $ composer test, <sub>(*15)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*16)</sub>

Security

If you discover any security related issues, please email oliver.ziegler@webfactor.de instead of using the issue tracker., <sub>(*17)</sub>

Credits

• Webfactor
• Oliver Ziegler
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*18)</sub>