jcergolj/laravellte

Fully customizable and tests supported Laravel admin dashboard 2.0

Fully customizable and tests supported Laravel admin dashboard 2.0

Intro

This is a boilerplate for opinionated Laravel 8.0 admin panel build with AdminLTE 3.0 theme, Alpinejs 2.0, Livewire 2.0, supported with tests and optional feature branches.

You can check this repo I am actively working on Laravel Castra. Same idea, different tools (Hotwire Turbo).

Contents

• Have total control of the code
• Summary
• Feature Branches
• Installation
• Care for the code
• Files scaffolding
• Authorisation
• Licence
• Contributors

Have total control of the code

Sometimes packages are to too big or too cumbersome to use. Other times package doesn't have a critical feature that you are looking for and you are doing some hacks to get around it.

What you are missing is having control over the code, and now you have it! Don't like how a new user is added. No problem. You can amend the code however you like. No more forking packages and messing with their code. The idea is to create branches of standard features and make them available for others to merge them into their master branch.

Summary

• Laravel 8.0, Alpinejs, Livewire 2.0, AdminLTE theme 3.0 ✔️
• Login ✔️
• Forgot Password ✔️
• CRUD for Users ✔️
• Welcome email for a new user with a link for setting up a new password ✔️
• CRUD for roles (basic auth system) ✔️
• Option to assign route based permissions to role ✔️
• Profile with change password, email and user's image option ✔️
• Confirmation email to confirm a new user's email ✔️
• File scaffolding ✔️
• CI included (github actions) ✔️
• Over 200 tests included ✔️

Feature Branches

Here is the list of supported feature branches. By merging them into master you unlock new features.

1. User Registration
2. Simple Role Based Authorisation

Installation

After installing Laravel you should run those commands:

git clone https://github.com/jcergolj/laravellte.git
composer install
cp .env.example .env
php artisan key:generate
npm install
npm run dev
composer cghooks update
php artisan migrate:fresh --seed

Care for the code

Let's face it. Sometimes we are sloppy, and we don't take the best care of the code. I added some useful packages (isn't it ironic) to take as much burden off developer as possible.

• Before you commit, the code is auto-styled according to Laravel standards using matt-allan/laravel-code-style package.
• Next nunomaduro/phpinsights package inspects the code and alerts if code is not in the best shape.

"php artisan insights --no-interaction --min-quality=90 --min-complexity=85 --min-architecture=90 --min-style=95"

• Are tests still slow? johnkary/phpunit-speedtrap package finds the slow tests for you.
• Lastly brainmaestro/composer-git-hooks package is utilized so everything is done automatically. See how

Files Scaffolding

For CRUD actions you might consider using built-in files scaffolding command. It generates files for Index, Create, Show, Edit and Delete actions like this:

php artisan make:ltd-component bla --index --create --show --edit --delete

You can omit any of the options. If you wish you can update the stubs files as you like. There are comments in scaffolded files acting as a reminder for you to amend the code. You can find then by typing: index-review, create-review, show-review, edit-review, delete-review. Factory and Model scaffolding aren't included in this command.

Authorisation

Laravellte uses role - permissions based authorisation system. Only users with Admin role can add new roles and assign permissions to it.

About permissions

For new resources permissions are added through PermissionsTableSeeder. By convention the main permissions type are index, create, edit, show, and delete with resource in plural prefix. Example: users.index. Having said that, you are free to add your own. However you'll have to review/amend the code.
Based on convention route names must be on of those types: index, create, edit, show, and delete. See example.
For livewire components the convention for naming them is as follows: you have to use one those types follow by resource name and then Component. e.g. IndexUserComponent All Livewire components must use HasLivewireAuth trait. Here is implementation.

Owner restricted for index pages

When adding permission to the role, there is an extra filed called owner_restricted. If owner restricted field is true for any index page user with that permission can only see its own resources. However, in order this to work, resource must have owner_id filed and VisibleTo global attached in boot method.

Owner restricted for show, edit, delete actions

If owner restricted field is true for show, edit and delete types, user can only amend resources that he owns.

Owner restricted for create

For create types owner restricted is ignored.

For Route Gate

In the core of it is ForRouteGate that handles authorisation. The honourable mention goes to Authorisation Middleware.

Authorisation cookbook

1. Apply permissions to the role.
2. Make sure that Authorisation middleware is applied to resource's routes Example
3. Make sure routes and permissions are named resources.index (according to convention) Example
4. Make sure VisibleTo global scope is applied to models Example
5. Make sure HasLivewireAuth trait is applied to all Livewire Components Example

Warning

For Admin Role permissions restriction do not apply.

License

Licensed under the MIT license

Contributors

Janez Cergolj

Horacio Degiorgi

Chris Thompson

Maduka Jayalath

laravellte's Issues

Add Telescope

Consider adding Telescope

Replace default popup with modal window for delete confirmation

php artisan migrate:fresh --seed

Seeding the db throws an error:

 Illuminate\Contracts\Container\BindingResolutionException

  Target class [DatabaseSeeder] does not exist.

  at vendor/laravel/framework/src/Illuminate/Container/Container.php:811
    807▕
    808▕         try {
    809▕             $reflector = new ReflectionClass($concrete);
    810▕         } catch (ReflectionException $e) {
  ➜ 811▕             throw new BindingResolutionException("Target class [$concrete] does not exist.", 0, $e);
    812▕         }
    813▕
    814▕         // If the type is not instantiable, the developer is attempting to resolve
    815▕         // an abstract type such as an Interface or Abstract Class and there is

      +35 vendor frames
  36  artisan:37
      Illuminate\Foundation\Console\Kernel::handle()

Send welcome email when admin creates new user

add security check

User delete and new user invite issue

User deletion doesn't delete from the database, and new user invitation doesn't send any mail. In livewire component, I ve seen new user invitation is set for next day, I have made it now, but the signed link doesn't work

add laravel enviroment check package marcel

Restrict access to routes by roles midleware

Add CI

Update readme

Fake controller's private function

add js prettier

Smplified authorisation with roles, no permissions

New branch with owner restricted example

add should be strict

Profile Image Update error

First time profile image update error gives.. image is required.. 2nd time it works well

New branch with registration form

Many packages aren´t updated. Most of them are for Laravel 7.3 istead of laravel 8.0

Livewire, nested components and validation errors bug

Should I replace old auth 3.0 with new Laravel Sail?

Do you have any thoughts on this?

User deletion doesn't delete from the database

User deletion doesn't delete from the database

Add two factor auth

Are you sure pop-up modal window build with alpinejs

Password confirmation bug

If null password confirmation is ignored

Replace Livewire components with Full-Page Components

Update readme

add pint laravel

Roles as constants

Add stubs command

A command would create:

• model stub
• controller stub
• livewire components stub
• tests stub

Add tests for model attribute cast

Real time validations

livewire compoments from @ to <

fix mailer issue

Extract Delete Entity to its own Livewire component

pivot not found

After logging to different user.. error throws at app/Scopes/VisibleToScopes.php line 50
trying to get property 'pivot' of non object

fix alpine js issue

Replace ajax image upload with livewire component

Alpine.js 3

Any plan upgrade to version 3?

Replace verify email package with custom code and add tests

Add users and roles with blueprint

Extract input wrapper html in a group laravel component

Add test to verify input fields are pre-populated for livewire components