parsampsh/adminx

Adminx is a library to create automatic admin panel for Laravel web applications

1.0 2022-03-14 20:07 UTC

Requires

• php: ^8.0
• doctrine/dbal: ^3.0
• laravel/framework: ^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• orchestra/testbench: ^6.0
• phpstan/phpstan: ^0.12.83
• phpunit/phpunit: ^9.3

MIT

• Parsa Shahmaleki

README

Adminx is a library to create and handle admin panel automaticaly in laravel applications.

Why Adminx?

Some of Adminx features:

• Easy to install and configure
• Secure
• Beautiful default template
• Customizable panel general information
• Adding custom pages and links to the admin panel menu
• Automatic and advanced CRUD for models with useful options
• Fully matched with your database models
• Handling 1 to n and n to n relations in database
• Custom actions for model datatable
• Handling admins activities and logs
• Customizable frontend layout
• Customizable language and localization
• RTL layout
• Several builtin themes
• Advanced permission and group handling system
• Customizable authorization
• Advanced options for model datatable
• Virtual fields for models
• Search system
• Advanced options for filtering data in datatables
• Customizable create/update forms
• Able to be used for End-User
• Matched with laravel authentication system
• Plugin system

Preview

Authors

This library is written by parsampsh.

Get started

To get started with this package, do the following steps in your laravel project:

• Add the package via composer: $ composer require parsampsh/adminx
• Publish public assets: $ php artisan vendor:publish --provider="Adminx\AdminxServiceProvider"
• Run the migrations: $ php artisan migrate

Then, adminx is ready to be used. create routes/adminx.php file and go to app/Providers/RouteServiceProvider.php and include that in End of the boot method:

// ...

include base_path('routes/adminx.php');

// ...

Then, write this code in routes/adminx.php:

// ...

$admin = new \Adminx\Core;

// set the admin panel configurations on $admin object

// register the admin panel
$admin->register('/admin'); // `/admin` is the route of admin panel

// ...

Now, run $ php artisan optimize, $ php artisan serve and goto /admin page. Remember that to access to the admin panel you must be logged in using the laravel auth.

Enjoy it!

Documentation

To learn how to use Adminx, read the documentation in doc folder.

Contribution Guide

If you want to contribute to this project, read This Contribution Guide

Changelog

See the changelog of Adminx versions here.

Security Policy

See the Adminx security policy here.

License

Adminx is licensed under MIT.