larawhale/cms

A Laravel cms package

0.1.2 2020-10-12 18:55 UTC

Requires

• php: ^7.4
• laravel/framework: ^8.0
• laravel/ui: ^3.0
• laravelcollective/html: ^6.0

Requires (Dev)

• barryvdh/laravel-debugbar: ^3.0
• orchestra/testbench: ^6.0
• orchestra/testbench-browser-kit: ^6.0
• orchestra/testbench-dusk: ^6.0
• owowagency/laravel-test-response: ^0.0.5
• phpunit/phpunit: ^9.0
• spatie/phpunit-snapshot-assertions: ^4.0
• squizlabs/php_codesniffer: ^3.0

MIT

• Thomas van der Veen

README

A Laravel package that provides the features of a content management system to any new or existing Laravel application.

This package uses a simple concept of two entities, entries and fields. Entries can be seen as models, where fields are the properties of these models.

The goal of this package is to take the implementation of managing content out of the hands of the developer while maintaining as much customizability as possible. It is important to keep the development process the same as how developers are used to while using the Laravel framework.

Installation

This package can be installed using composer:

composer require larawhale/cms

Read more about the installation of this package in the documentation.

Example

Here is a quick example how an entry can be configured. The entry will be made available in the user interface when it is saved in the default resources/entries folder.

// resources/entries/post.php
return [
    'type' => 'post',
    'name' => 'Post',
    'view' => 'entries.post',
    'fields' => [
        [
            'key' => 'route',
            'type' => 'route',
            'config' => [
                'rules' => 'required',
                'label' => 'Url',
            ],
        ],
        [
            'key' => 'title',
            'type' => 'text',
            'config' => [
                'rules' => 'required|string|max:191',
                'label' => 'Title',
            ],
        ],
        [
            'key' => 'body',
            'type' => 'textarea',
            'config' => [
                'rules' => 'required|string|max:1000',
                'label' => 'Body',
            ],
        ],
    ],
];

More information can be found at the entries configuration and fields configutation documentation.

This configuration will result in the following form to be rendered in the user interface.

The configured fields of this entry have now been made available in the configured resources/views/entries/post.blade.php file.

// resources/views/entries/post.blade.php
<h1>
    {{ $entry->title }}
</h1>

{!! $entry->body !!}

Documentation

The documentation is available on the repository wiki.

License

This package falls under the MIT License (MIT). See the license file for more information.