Skip to content

Commit 40d4a34

Browse files
committed
readme update and config file update
1 parent 843295b commit 40d4a34

File tree

2 files changed

+10
-18
lines changed

2 files changed

+10
-18
lines changed

README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Complete Laravel Blog Package
1+
# Hessam CMS - Complete Laravel CMS Package
22
## With Multi-level Categories and Full Text Search
3-
It has everything you need to quickly and easily add a blog to your laravel app.
3+
It has everything you need to quickly and easily add a CMS to your existing laravel application.
44

55
## [Online Demo](https://cms.binshops.com/login)
66
You can check Hessam CMS online: [https://cms.binshops.com](https://cms.binshops.com/login)
@@ -15,8 +15,11 @@ Install with following command and follow the instructions.
1515

1616
To see package on Packagist click this [Link](https://packagist.org/packages/hessam/laravel-blogger)
1717

18+
## Important Notes
19+
- For laravel 8.x's default auth User model, change user model in `blogetc.php` to: `\App\Models\User::class`
20+
1821
## Recent Changes
19-
- **8.0.0** Compatibility with Laravel 8
22+
- **8.0.x** Compatibility with Laravel 8.x
2023

2124
### Screen Shots
2225

@@ -83,26 +86,14 @@ To see package on Packagist click this [Link](https://packagist.org/packages/hes
8386
- Create / edit posts
8487
- Create / edit post categories
8588
- Manage (approve/delete) submitted comments
89+
- Multi-level category
8690
- Allows each blog post to have featured images uploaded (you can define the actual dimensions) - in large, medium, thumbnail sizes
8791
- fully configurable via its `config/blogetc.php` config file.
8892
- **Includes all required view files, works straight away with no additional setup.** All view files (Blade files) use Bootstrap 4, and very clean HTML (easy to get your head around). You can easily override any view file by putting files in your `/resources/views/vendor/blogetc/` directory
8993
- **Built in comments (using the database)**, can auto approve or require admin approval (comment moderation).
9094
- Other options include using [Disqus](http://disqus.com/) comments or disabling comments.
9195
- Includes unit tests.
9296
- Fires events for any database changes, so you can easily add Event Listeners if you need to add additional logic.
93-
- **< 5 minute install time** and your blog is up and working, ready for you to go to the admin panel and write a blog post - see full details below, but this is a summary of the required steps:
94-
- install with composer,
95-
- do the database migration, copy the config file over (done with `php artisan vendor:publish`)
96-
- chmod/chown the `public/blog_images/` directory so featured images can be uploaded for each blog post
97-
- and then add 1 method to your `\App\User` file (`canManageBlogEtcPosts()`
98-
- __but please see the install instructions to get everything up and working__
99-
100-
## Important notes
101-
102-
1) Anyone who can manage blog posts (defined by the `canManageBlogEtcPosts()` method you add to your User model) can submit any HTML which is echoed out. This is a security issue. If you don't trust the content you should add a custom view and escape the blog content before echoing it, and set `use_custom_view_files` in the config to false.
103-
104-
2) if `use_custom_view_files` is enabled in the config (which it is by default), it means that any post with a custom view file set (details in the docs) can include any file within `/resources/views/custom_blog_posts`, which blade will execute. This package gives no method to edit any file within that directory though.
105-
10697

10798
## How to customise the blog views/templates
10899

@@ -123,7 +114,7 @@ It will auto set all required routes (both public facing, and admin backend). Th
123114
All config options have comments which describe what they do. Please just refer to the `blogetc.php` file in your /config/ dir.
124115

125116
### Custom User Model
126-
You can change the default user model through the config file
117+
You can change the default user model through the config file.
127118

128119
## Events
129120

src/Config/blogetc.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
return [
66

7-
//your custom User model
7+
//Your custom User model
8+
//Change it to \App\Models\User::class for laravel 8.x's default auth User model
89
'user_model'=>\App\User::class,
910

1011
// reading progress bar is the bar which shows on top of your post when you are scrolling down the page. You can disable this feature if you want

0 commit comments

Comments
 (0)