README

About Admin Panel

Admin Panel is a TALL based solution to be able to administer users, roles and permissions. It requires several composer packages:

These are all required dependencies that will be installed if needed.

Installation

-only for development-

To get started, add a local repository to Composer:

{
    "repositories": {
        "admin-panel": {
            "type": "path",
            "url": "/path-to-downloaded-file/fefo-p/admin-panel",
            "options": {
                "symlink": true
            }
        }
    }
}

-production-

Then, require the package via Composer:

composer require fefo-p/admin-panel

Warning

You might want to publish the config and migrations before running the install command as will automatically migrate the DB.

To find out the available options to publish, just issue a
php artisan vendor:publish
and check for every entry with adminpanel

If in doubt, check laravel's artisan cli documentation

Seriously, you've been warned...

Initial setup

Execute the following command to do the initial setup.

php artisan adminpanel:install

It will create one role administrador with three permissions:

crear, ver, editar y borrar usuarios
crear, ver, editar y borrar roles
crear, ver, editar y borrar permisos

There are a few options available with the installation command, but not required

--profile-image Updates jetstream to use profile images and publishes a default anonymous profile image

--verification Makes the User model implement MustVerifyEmail, as well as allow email verification feature in fortify,

--with-user Creates a default admin user

Note

TODO: ask for user details while installing

 php artisan adminpanel:install [--with-user] [--profile-image] [--verification]

Environment setup

If there's a combination of external & internal users (then you only need to manage the internal user's permissions), you should add two environment variables:

ADMINPANEL_EXTERNAL_USERS=true
ADMINPANEL_EXTERNAL_COLUMN='externo'

where the first one indicates if there are external users, and the second indicates the column, in the users table, which will be responsible for letting us know if the user is external or internal.

Assets

You can publish all assets issuing the command, or just select individually the assets you want to publish

php artisan vendor:publish --tag=adminpanel

Configuration

You can customize the Modal via the adminpanel.php config file. This includes some additional options like ...

To publish the config run the vendor:publish command:

php artisan vendor:publish --tag=adminpanel-config

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Include CSS
    |--------------------------------------------------------------------------
    |
    | The modal uses TailwindCSS, if you don't use TailwindCSS you will need
    | to set this parameter to true. This includes the modern-normalize css.
    |
    */
    'include_css' => false,


    /*
    |--------------------------------------------------------------------------
    | Include JS
    |--------------------------------------------------------------------------
    |
    | Livewire UI will inject the required Javascript in your blade template.
    | If you want to bundle the required Javascript you can set this to false
    | and add `require('vendor/wire-elements/modal/resources/js/modal');`
    | to your script bundler like webpack.
    |
    */
    'include_js' => true,


    /*
    |--------------------------------------------------------------------------
    | Modal Component Defaults
    |--------------------------------------------------------------------------
    |
    | Configure the default properties for a modal component.
    | 
    | Supported modal_max_width
    | 'sm', 'md', 'lg', 'xl', '2xl', '3xl', '4xl', '5xl', '6xl', '7xl'
    */
    'component_defaults' => [
        'modal_max_width' => '2xl',
        
        'close_modal_on_click_away' => true,

        'close_modal_on_escape' => true,

        'close_modal_on_escape_is_forceful' => true,

        'dispatch_close_event' => false,
        
        'destroy_on_close' => false,
    ],
];

Setup Vite using SSL

import { defineConfig } from 'vite';
import laravel, { refreshPaths } from 'laravel-vite-plugin';

// add these 2 lines
const domain = "broadcast.test";
const homedir = require("os").homedir();
// end add

export default defineConfig({
    plugins: [
        laravel({
            input: [
                'resources/css/app.css',
                'resources/js/app.js',
            ],
            refresh: [
                ...refreshPaths,
                'app/Http/Livewire/**',
            ],
        }),
    ],
    // add this block
    server: {
        https: {
            key: homedir + "/.config/valet/Certificates/" + domain + ".key",
            cert: homedir + "/.config/valet/Certificates/" + domain + ".crt",
        },
        host: domain,
        hmr: {
            host: domain,
        },
    },
    // end add
});

Laravel Websockets

confif/broadcasting.php

[...]
    'connections' => [

        'pusher' => [
            'driver' => 'pusher',
            'key' => env('PUSHER_APP_KEY'),
            'secret' => env('PUSHER_APP_SECRET'),
            'app_id' => env('PUSHER_APP_ID'),
            'options' => [
                // 'host' => env('PUSHER_HOST', 'api-'.env('PUSHER_APP_CLUSTER', 'mt1').'.pusher.com') ?: 'api-'.env('PUSHER_APP_CLUSTER', 'mt1').'.pusher.com',
                'host' => '-----------------your-servers-url-----------------',
                // 'port' => env('PUSHER_PORT', 443),
                'port' => env('PUSHER_PORT', 6001),
                'scheme' => env('PUSHER_SCHEME', 'https'),
                'encrypted' => true,
                'useTLS' => env('PUSHER_SCHEME', 'https') === 'https',
            ],
            'client_options' => [
                // Guzzle client options: https://docs.guzzlephp.org/en/stable/request-options.html
            ],
        ],
[...]

Websockets with SSL

.env

PUSHER_APP_ID=something_id
PUSHER_APP_KEY=something_key
PUSHER_APP_SECRET=something_secret
PUSHER_HOST=-----------------------domain.com-----------------------
PUSHER_PORT=6001
PUSHER_SCHEME=https

LARAVEL_WEBSOCKETS_SSL_LOCAL_CERT='/some-path-to-ssl-certificates/bcast.test.crt'
LARAVEL_WEBSOCKETS_SSL_LOCAL_PK='/some-path-to-ssl-certificates/bcast.test.key'

Conecting to Echo

resources/views/layouts/app.blade.php

document.onreadystatechange = function () {
    if (document.readyState === 'complete') {
        Echo.join('logged_in')
            .here((users) => {
                console.log(users);
            })
            .joining((user) => {
                console.log(user.name);
            })
            .leaving((user) => {
                console.log(user.name);
            })
            .listen('OrderStatusUpdated', (e) => {
                console.log(e);
            })
            .error((error) => {
                console.error(error);
            });
    }
};

Credits

Fernando M. Pintabona

License

Admin Panel is open-sourced software licensed under the MIT license.

fefo-p / admin-panel

Maintainers

Details