Package Data | |
---|---|
Maintainer Username: | binshops |
Maintainer Contact: | contact@binshops.com (Binshops) |
Package Create Date: | 2020-04-16 |
Package Last Update: | 2024-09-23 |
Home Page: | https://www.binshops.com |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-11-19 03:23:49 |
Package Statistics | |
---|---|
Total Downloads: | 34,764 |
Monthly Downloads: | 541 |
Daily Downloads: | 17 |
Total Stars: | 430 |
Total Watchers: | 19 |
Total Forks: | 134 |
Total Open Issues: | 22 |
Incredible features with a lightweight laravel blog package.
1- Install via composer
composer require binshops/laravel-blog
For a fresh Laravel installation run the following too:
composer require laravel/ui
php artisan ui vue --auth
2- Scaffold
npm install && npm run build
3- Run the following two commands to copy config file, migration files, and view files
php artisan vendor:publish --provider="BinshopsBlog\BinshopsBlogServiceProvider"
4- Execute migrations to create tables
php artisan migrate;
5- You must add one method to your \App\User (in laravel 8 \App\Models\User) model. As the name of this method shows it determines which user can manage posts. Place your logic there
/**
* Enter your own logic (e.g. if ($this->id === 1) to
* enable this user to be able to add/edit blog posts
*
* @return bool - true = they can edit / manage blog posts,
* false = they have no access to the blog admin panel
*/
public function canManageBinshopsBlogPosts()
{
// Enter the logic needed for your app.
// Maybe you can just hardcode in a user id that you
// know is always an admin ID?
if ( $this->id === 1
&& $this->email === "your_admin_user@your_site.com"
){
// return true so this user CAN edit/post/delete
// blog posts (and post any HTML/JS)
return true;
}
// otherwise return false, so they have no access
// to the admin panel (but can still view posts)
return false;
}
6- Create a directory in public/
named blog_images
7- Start the server
php artisan serve
8- Login as admin and setup your package: /blog_admin/setup
Congrats! Your blog is ready to use. (URLs are customizable in the config file)
Admin panel URI: /blog_admin
Front URI: /en/blog
To see package on Packagist click this Link
To install the single language version of the package use version v8.1x:
1- composer require binshops/laravel-blog:v8.1.2
2- php artisan vendor:publish --provider="BinshopsBlog\BinshopsBlogServiceProvider"
3- php artisan vendor:publish --tag=laravel-fulltext
4- php artisan migrate;
You can see the single version in "single-lang" branch.
binshopsblog.php
to: \App\Models\User::class
config/binshopsblog.php
config fileAfter doing the correct vendor:publish
, all of the default template files will be found in /resources/views/vendor/binshopsblog/ and are easy to edit to match your needs.
If you need to customize the admin view, just copy the files from
vendor/binshopsblog/src/Views/binshopsblog_admin
to
resources/views/vendor/binshopsblog_admin
Then you can modify them just like any other view file.
It will auto set all required routes (both public facing, and admin backend). There are some config options (such as changing the /blog/ url to something else), which can be done in the binshopsblog.php file.
All config options have comments which describe what they do. Please just refer to the binshopsblog.php
file in your /config/ dir.
You can change the default user model through the config file.
You can find all the events that are fired by looking in the /src/Events
directory.
Add these (and an Event Listener) to your EventServiceProvider.php
file to make use of these events when they fire.
There is a built-in captcha (anti-spam comment) system built in, which will be easy for you to replace with your own implementation.
There is a basic anti-spam captcha function built-in.
See the config/binshops.php captcha section. There is a built in system (basic!) that will prevent most automated spam attempts. Writing your own captcha system:
I wrote the captcha system simple on purpose, so you can add your own captcha options. It should be easy to add any other captcha system to this.
If you want to write your own implementation then create your own class that implements \BinshopsBlog\Interfaces\CaptchaInterface, then update the config/binshopsblog.php file (change the captcha_type option).
There are three methods you need to implement: public function captcha_field_name() : string
Return a string such as "captcha". It is used for the form validation and . public function view() : string
What view file should the binshops::partials.add_comment_form view include? You can set this to whatever you need, and then create your own view file. The default included basic captcha class will return "binshops::captcha.basic". public function rules() : array
Return an array for the rules (which are just the standard Laravel validation rules. This is where you can check if the captcha was successful or not. Optional: public function runCaptchaBeforeShowingPosts() : null
This isn't part of the interface, it isn't required. By default it does nothing. But you can put some code in this method and it'll be run in the BinshopsReaderController::viewSinglePost method.
Try adding this to config/app.php:
'Image' => Intervention\Image\Facades\Image::class