README

Simple Admin Generation

⛵simple-admin-generator is a powerful and easy-to-use package for generating admin functionalities in your Laravel application. With a focus on simplicity and efficiency, this package streamlines the creation and management of admin panels, making it easier for developers to build robust backend systems.

Requirements

PHP >= 8.1
Laravel >= 9.x

Prerequisites

If you don't already have an Apache local environment with PHP and MySQL, use one of the following links:

Also, you will need to install Composer: https://getcomposer.org/doc/00-intro.md
And Laravel: https://laravel.com/docs/9.x/installation

Make sure all database connections are set up correctly in your .env file.

Installation

Install package using command:

composer require hoangphamdev/simple-admin-generator

Run following command to install.

php artisan sag:install

Publish the package configuration:

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

This creates config/sag.php, where you can customize values such as page_name.

Seed the default administrator account:

php artisan sag:seed-admin

Seed the default admin menus:

php artisan migrate
php artisan sag:seed-menu

The menu management screen is available at /{sag.prefix}/menus (by default, /admin/menus).

For existing installations, publish the menu's jsTree assets from the host application:

php artisan vendor:publish --provider="HoangPhamDev\SimpleAdminGenerator\PackageServiceProvider" --tag=sag-menu-assets --force

These assets are also included in sag:install and the assets publish tag.

Menu creation, updates, deletion, seeding, and reordering automatically export all AdminMenuItem records to the host application's resources/admin-menu-items.json. The JSON is a flat array ordered by sort_order and id, including inactive items, with parent_id preserving the hierarchy. The directory and file are created when missing; the file is replaced atomically after the database transaction commits.

To customize the absolute file path, publish the configuration with php artisan vendor:publish --tag=sag-config and set this in config/sag.php:

'menu_json_path' => resource_path('menus/admin.json'),

To replace all existing menu records with the configured JSON file:

php artisan sag:sync-menu-from-json

The command is registered automatically by the package provider and reads sag.menu_json_path (default: resources/admin-menu-items.json). Use --connection=your_connection to select a database connection. It prints the imported item count and returns a nonzero exit code on failure.

You can also call the service directly:

$count = app(\HoangPhamDev\SimpleAdminGenerator\Services\AdminMenuJsonService::class)
    ->syncFromJson();

This returns the number of imported items. The file must use the same flat array format as the export, including unique id, key, and title fields. IDs and parent relationships are preserved even if children appear before parents. An empty array ([]) clears all menu records. Missing files, invalid JSON, duplicate IDs/keys, missing parents, and cycles are rejected before deletion. Database replacement runs in a transaction and rolls back on failure. Import does not rewrite the source JSON. Pass a connection name to syncFromJson() when importing into a non-default database connection.

Direct SQL, bulk Eloquent writes outside the menu service, and writes with model events disabled bypass automatic export. After such writes, call app(\HoangPhamDev\SimpleAdminGenerator\Services\AdminMenuJsonService::class)->syncAfterCommit( (new \HoangPhamDev\SimpleAdminGenerator\Models\AdminMenuItem())->getConnection() ); to refresh the file after commit.

Open http://localhost/admin/login in browser,use email admin@sag.com and password secret to login.

Edit your dashboard at resources/views/sag/dashboard.blade.php

Documentation

Generate new UI

This feature will generate a basic UI for you so that you can quickly create your own CRUD functionality.

Run following command:

php artisan sag:generate_ui <Your functionnalities name>

Example: php artisan sag:generate_ui Blog

Then open http://localhost/admin/blog to see your new UI. Your functionality files will be generated following the structure below. Open and edit them as you wish.

File Structure

┣ 📂Http
   ┗📂Controllers
     ┗📂SAG
       ┗📜BlogController.php
┣ 📂recources
   ┗ 📂views
      ┗ 📂sag
         ┗ 📂blog
            ┣📜create.blade.php
            ┣📜edit.blade.php
            ┣📜edit.blade.php
            ┣📜index.blade.php

Generate CRUD from a model or table

Generate a complete controller, routes, views, and (for a table source) an Eloquent model. The generated form selects x-sag-form.* controls from the database column types and supports list, search, create, edit, update, and delete operations.

php artisan sag:generate_crud --model=Employee
php artisan sag:generate_crud --table=employees
php artisan sag:generate_crud --table=employees --route-name=staff-members --controller=StaffMemberController --model-class=App\Models\StaffMember

Use exactly one of --model or --table. Optional --route-name must be kebab-case; --controller must be a StudlyCase name ending in Controller; and --model-class is available only with --table. Existing generated files are protected unless --force is passed. Add --skip-menu to omit the admin menu item.

Layout customization

Layouts are loaded directly from the package as sag::layouts.*; sag:install does not copy them into the application. To override them, publish a copy and edit it under resources/views/vendor/sag/layouts:

php artisan vendor:publish --tag=sag-layouts

Form components

The package includes server-rendered Bootstrap/AdminLTE form components. They work immediately after installing the package:

<x-sag-form.input name="email" label="Email" type="email" :value="$user->email ?? null" required />
<x-sag-form.select name="role_id" label="Role" :options="$roles" placeholder="-- Choose a role --" />
<x-sag-form.multi-select name="role_ids" label="Roles" :options="$roles" :selected="$user->roles->pluck('id')" />
<x-sag-form.checkbox name="active" label="Active" :checked="$user->active" />
<x-sag-form.file name="avatar" label="Avatar" accept="image/*" />
<x-sag-form.datetime name="published_at" label="Published at" :value="$post->published_at?->format('Y-m-d H:i')" />

Available controls are field, input, textarea, select, multi-select, checkbox, radio, file, and datetime. Controls use Laravel old() input before their provided value, render the first validation error, and preserve custom HTML attributes. Options must be a value-to-label array or Collection; optgroups and object mappings are not supported in this phase. File upload forms must use enctype="multipart/form-data".

datetime lazily loads bundled Flatpickr assets and submits Y-m-d H:i (Y-m-d H:i:S when enable-seconds is set). Assets are installed by php artisan sag:install; without that installer publish them with:

php artisan vendor:publish --tag=assets --force

To customize component markup, publish the views and edit the corresponding file under resources/views/components/sag-form:

php artisan vendor:publish --tag=sag-form-components

Other

simple-admin-generator based on following plugins or services:

License

simple-admin-generator is licensed under The MIT License (MIT).

hoangphamdev / simple-admin-generator

Package info

Security

Statistics