README

This is a package providing a Simple UI for Laravel Folio that provides a simple UI and Markdown editor for managing your blog content. View all your posts, create new ones, edit existing ones, and delete them.

Installation

You can install the package via composer:

composer require ejntaylor/vellum

Folio Installation

Folio is a required package so will be installed automatically. You will need to follow the instructions to install Folio.

Specifially, you will need to run the following commands:

php artisan folio:install

Until Folio is out of beta you will need to set the following in your composer.json file:

    "minimum-stability": "beta"

You will then need to publish the assets so we can style Vellum:

php artisan vendor:publish --tag="vellum-assets"

You can publish the config file with:

php artisan vendor:publish --tag="vellum-config"

This is the contents of the published config file:

return [
    'middleware' => [
        'auth' => \Ejntaylor\Vellum\Http\Middleware\AuthMiddleware::class,
    ],
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="vellum-views"

Auth

You might already have Authentication setup. If you are starting with a fresh install you might want to use the Laravel Breeze package to get up and running quickly.

composer require laravel/breeze --dev
php artisan breeze:install

Usage

Install with the above instructions and make sure to publish the assets.

Make sure you have auth setup.

Then head to https://yourapp.com/vellum to view the UI. Login and go - that's it!

Changelog

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

Contributing

I welcome all contributions - please submit a Pull Request and I'll review it as soon as I can.

Security Vulnerabilities

Please get in touch to report security vulnerabilities.

Credits

Elliot Taylor

License

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

ejntaylor / vellum

Maintainers

Details