xoborg/laravel-blog

A simple blog package for Laravel

Downloads

11

Stars

1

Version

1.0.2

A simple blog package for Laravel

Latest Version on Packagist Total Downloads License

Installation

You can install the package via composer:

composer require xoborg/laravel-blog

This package uses Laravel's authentication scaffold, so if you don't already have it set-up just run php artisan make:auth.

Then execute php artisan migrate to create laravel-blog and Laravel tables.

Next, you must publish the config file:

php artisan vendor:publish --provider="Xoborg\LaravelBlog\LaravelBlogServiceProvider" --tag="config"

Finally, you need to publish a necessary JavaScript file for the Backend:

php artisan vendor:publish --provider="Xoborg\LaravelBlog\LaravelBlogServiceProvider" --tag="public" --force

Usage

Your blog will be installed in http://your-app.test/blog but you wont be able to publish posts until you are added as author, to do that you can use:

php artisan laravel-blog:author --add 1 // User ID

Then, if you are logged in to your app, you will be able to access the admin panel located in http://your-app.test/blog/backend.

Other commands

To remove a user as an author run:

php artisan laravel-blog:author --remove 1 // User ID

You also can see an author list:

php artisan laravel-blog:author --list

Posts images

This package uses the Trix editor, which has the ability to attach images to the posts. This images will be stored in the public disk so don't forget to execute the next command:

php artisan storage:link

Customize the views

If you want to customize the backend or frontend views of this package, publish the views files with the next command:

php artisan vendor:publish --provider="Xoborg\LaravelBlog\LaravelBlogServiceProvider" --tag="views"

RSS feed

Laravel Blog has support for spatie/laravel-feed package to generate a RSS feed of your blog,

Register the routes the feeds will be displayed on using the feeds-macro.

// In routes/web.php
Route::feeds();

Next, you must publish the config file:

php artisan vendor:publish --provider="Spatie\Feed\FeedServiceProvider" --tag="config"

Then you need to specify in this config file which class and method will return the items that should appear in the feed:

...
'items' => 'Xoborg\LaravelBlog\Models\Post@getFeedItems',
...

If you want feed readers to discover your feed, you should publish Laravel Blog views and add this in the <head> tag:

 @include('feed::links')

Finally, you can set the number of items that will be displayed in the feed by changing it in config/blog.php:

...
'feed' => [
	/**
	 * The number of items that should appear in the feed
	 */
	'items' => 25
]
...

Testing

composer test

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

Check out our website at xoborg.com for more information about Xoborg Technologies.

License

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

Xoborg

Author

Xoborg