README

Installable Livewire admin panel for Laravel projects.

Requirements

• PHP 8.2+
• Laravel 11/12/13
• Livewire 3 or 4

Installation

composer require adminpanel-byme/installer

Quick Start

Run interactive installer:

php artisan adminpanel:install

The command will prompt for:

• Route prefix (example: admin)
• Middleware (example: web,auth)
• Auth pages enable/disable

Then run:

npm install
npm run build
php artisan optimize:clear

Non-Interactive Usage

php artisan adminpanel:install --prefix=admin --middleware=web,auth --with-auth

Disable auth pages:

php artisan adminpanel:install --prefix=admin --middleware=web --without-auth

Overwrite existing files:

php artisan adminpanel:install --force

What Gets Installed

• Livewire admin/auth page classes
• Blade layouts and admin shell
• Reusable UI components (x-ui.card, x-ui.section-title, etc.)
• Admin pages (dashboard, users, forms, settings, calendar)
• config/adminpanel.php
• routes/adminpanel.php
• resources/css/adminpanel.css
• resources/js/adminpanel.js

Installer also:

• Appends require __DIR__.'/adminpanel.php'; to routes/web.php (once)
• Adds Vite inputs for adminpanel assets (once)
• Adds required JS dependencies in package.json if missing
• Applies .env overrides when options are provided

Route Config

Environment variables:

ADMINPANEL_ROUTE_PREFIX=admin
ADMINPANEL_ROUTE_MIDDLEWARE=web,auth
ADMINPANEL_AUTH_ENABLED=true
ADMINPANEL_AUTH_PREFIX=auth

Publish Flow (Maintainer)

1. Push this package folder to its own repository:
   • https://github.com/adminpanel-byme/adminpanel-installer
2. Run release checks:

composer run release:check

1. Commit and tag release:

git add .
git commit -m "release: v1.0.0"
git tag v1.0.0
git push origin main --tags

1. Submit repository URL to Packagist.
2. Optional but recommended: set Packagist GitHub webhook so new tags auto-sync.

After that, users can install via composer require adminpanel-byme/installer.