Skip to content
Ready to use Documents Backpack CRUD with API route for eg. privacy statement, imprint, sbt or gtc
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config/webfactor
database
resources/lang
routes/webfactor
src
tests
.editorconfig
.scrutinizer.yml
.styleci.yml
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE.md
PULL_REQUEST_TEMPLATE.md
README.md
composer.json
phpunit.xml

README.md

LaravelBackpackDocuments

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

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

Install

Via Composer

$ composer require webfactor/laravel-backpack-documents

Publish the vendor files

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

Run the migration

$ php artisan migrate

[optional but recommended] add a menu item to your 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>

Usage

Define your document types in the published config file. Don't forget to add appropriate translations in the translation files.

Backend

Go to the defined route (default: wfcms/document) and edit your documents like in Backpack CRUD

Api

Send a GET-request to the api route (default: api/v1/documents).

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

Customisation

You can edit many parts of the functionality. Just look at the published config file (config/webfactor/documents.php).

If you want to overwrite the default routes, please create a route file at routes/webfactor/documents.php and define your routes there.

For using translations check the installed version of spatie/laravel-translatable for more information.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email oliver.ziegler@webfactor.de instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

You can’t perform that action at this time.