davide-casiraghi/laravel-testimonials

A Laravel package to show testimonials trough a carousel. The contents support multi language.

1.0.2 2020-01-21 13:32 UTC

This package is auto-updated.

Last update: 2024-04-22 01:58:51 UTC


README

Latest Version on Packagist Build Status StyleCI Quality Score Coverage Status 68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f66623665656638656435306164333362386632382f6d61696e7461696e6162696c697479 GitHub last commit

A Laravel package to show testimonials trough a carousel. The contents support multi language.

Installation

You can install the package via composer:

composer require davide-casiraghi/laravel-testimonials

Publish all the vendor files

php artisan vendor:publish --force

Run the database migrations

php artisan migrate

Install also slick carousel

npm install slick-carousel

Import the scss files

Add this line to your resources/sass/app.scss file:

@import "~slick-carousel/slick/slick";
@import "~slick-carousel/slick/slick-theme";
@import 'vendor/laravel-testimonials/testimonials';

and then run in console:
npm run dev

Import the js files

Add this line to your resources/js/app.js file:

require('./vendor/laravel-testimonials/testimonials');   
import 'slick-carousel';    

Usage

Authorization

To work the package aspect that in your user model and table you have a field called group that can have this possible values:

  • null: Registered user
  • 1: Super Admin
  • 2: Admin

Just the users that have Admin and Super admin privileges can access to the routes that allow to create, edit and delete the blogs, categories and posts. Otherwise you get redirected to the homepage.

Access to the package

After the package is published this new routes will be available:

  • /testimonialGroups
  • /testimonials

Accessing to this routes you can manage new testimonial groups and testimonials.

Replace the snippet occurrances

Add the replace funcion to your code in the show() funcion of the controller.

use DavideCasiraghi\LaravelTestimonials\Facades\LaravelTestimonials;  

$text = LaravelTestimonials::replace_testimonial_group_snippets_with_template($text);

Use the code snippet in your posts

Then the library will replace all the occurances of this snippet:

{# testimonial_group testimonial_group_id=[1] #}

with the some HTML code of the relative testimonial group. This code uses bootstrap 4.

Testing

./vendor/bin/phpunit --coverage-html=html

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email davide.casiraghi@gmail.com instead of using the issue tracker.

Credits

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.