README

Lvntr Starter Kit is under active development, and each release is shaping it into a more complete admin-first Laravel platform.

Detailed usage docs: kit-docs.lvntr.dev

A full-featured Laravel admin panel package built with Laravel 12 & 13, Inertia.js v2, Vue 3, PrimeVue 4, and Tailwind CSS 4. Follows DDD (Domain-Driven Design) architecture with built-in role-based permissions, activity logging, settings management, and more.

Version support: the main branch targets Laravel 13 (v13.x tags). For Laravel 12 use the 1.x branch (v12.x tags).

Features

• DDD Architecture — Actions, DTOs, Queries, Events, Listeners
• Role & Permission Management — Spatie Permission with dynamic resource-scoped permissions
• User Management — CRUD with avatar upload, soft deletes, 2FA support
• Activity Logging — Spatie Activity Log with a browsable admin interface
• Settings Panel — General, Auth, Mail, Storage settings stored in database
• OAuth2 API — Laravel Passport with personal access tokens and device authorization
• Domain Scaffolding — make:sk-domain command generates full DDD stack interactively
• FormBuilder / DatatableBuilder / TabBuilder — Reusable Vue component builders
• Multi-language Support — Translation files included, easily extendable
• API Response Builder — Fluent, consistent API responses with pagination support
• Security Headers Middleware — X-Frame-Options, HSTS, CSP and more

Tech Stack

Backend (PHP / Composer)

Frontend (Node / npm)

Dev Tools

Requirements

• PHP 8.2+ (8.3+ recommended for Laravel 13)
• Laravel 12 or 13
• Node.js 18+
• MySQL / PostgreSQL / SQLite

Installation

1. Require the package

# Laravel 13 (latest)
composer require lvntr/starter-kit:^13.0

# Laravel 12 (maintenance)
composer require lvntr/starter-kit:^12.0

2. Run the install command

php artisan sk:install

This interactive wizard will:

1. Publish all application scaffolding (Controllers, Models, Routes, Vue pages, etc.)
2. Publish the package config file
3. Run database migrations
4. Run seeders (Roles, Permissions, Definitions, Settings)
5. Generate Passport encryption keys
6. Create a default admin user
7. Install npm dependencies and build frontend assets

Non-interactive mode (CI/CD):

php artisan sk:install --no-interaction

Overwrite existing files:

php artisan sk:install --force

3. Configure your .env

APP_NAME="My Application"
APP_URL=https://my-app.test

DB_CONNECTION=mysql
DB_DATABASE=my_app
DB_USERNAME=root
DB_PASSWORD=

4. Access the admin panel

Open your browser and navigate to your app URL. Log in with the admin credentials shown after installation (default: admin@demo.com / password).

Updating

When a new version of the package is released:

composer update lvntr/starter-kit
php artisan sk:update

The update command uses a hash-based tracking system to safely update files:

• Core files (BaseAction, BaseDTO, Traits, Middleware, helpers) are always updated
• User-modifiable files (Controllers, Pages, Routes) are only updated if you haven't changed them
• New files from the package are automatically added
• New migrations are detected and optionally run

Preview changes before applying:

php artisan sk:update --dry-run

Force update everything (overwrites your changes):

php artisan sk:update --force

Upgrading from Laravel 12 to 13

The main branch of this package supports both Laravel 12 and Laravel 13. When you move an existing Laravel 12 application to the Laravel 13 line, the upgrade is split into two stages:

1. Bump Laravel yourself

The package does not touch composer.json or upgrade the framework for you — that stays under your control. Update your composer.json:

{
    "require": {
        "php": "^8.3",
        "laravel/framework": "^13.0",
        "lvntr/starter-kit": "^13.0"
    }
}

Then run composer update.

2. Finish the package-side work with sk:upgrade

Once Laravel itself is on 13, run:

php artisan sk:upgrade

The command performs preflight checks (Laravel ≥ 13, Starter Kit ≥ v13, PHP ≥ 8.3) and refuses to run if any of them fails — it will not modify a single file in that case. On success it:

1. Syncs Starter Kit stubs (sk:update), preserving your edits
2. Clears framework caches and stale bootstrap/cache/*.php files
3. Regenerates the Composer autoload
4. Runs new migrations
5. Re-seeds roles and permissions
6. Reinstalls npm dependencies and rebuilds frontend assets

Options:

For the full upgrade checklist, rollback plan, and troubleshooting tips, see the Upgrade Guide.

Publishing Optional Assets

The package keeps Vue components, language files, and config inside the package by default. If you need to customize them, publish them to your project:

# Interactive selection
php artisan sk:publish

# Publish Vue components (FormBuilder, DatatableBuilder, etc.)
php artisan sk:publish --tag=components

# Publish language files
php artisan sk:publish --tag=lang

# Publish config file
php artisan sk:publish --tag=config

Available Commands

Domain Scaffolding

Create a new domain with all DDD layers:

# Interactive mode
php artisan make:sk-domain

# With options
php artisan make:sk-domain Product --fields="name:string,price:decimal" --admin --api --events --vue=full

This generates: Model, Migration, Factory, DTO, Actions, Events, Listeners, Controllers, FormRequests, Routes, and Vue pages.

Remove a domain:

php artisan remove:sk-domain Product

Architecture

Package Structure

lvntr/starter-kit/
├── src/                          # Core package code (never published)
│   ├── StarterKitServiceProvider.php
│   ├── Console/Commands/         # sk:install, sk:update, make:sk-domain, etc.
│   ├── Domain/Shared/            # BaseAction, BaseDTO, ActionPipeline
│   ├── Enums/                    # PermissionEnum
│   ├── Http/Middleware/          # CheckResourcePermission, SecurityHeaders
│   ├── Http/Responses/           # ApiResponse builder
│   ├── Support/                  # Package support classes
│   ├── Traits/                   # HasActivityLogging, HasMediaCollections
│   └── helpers.php               # to_api(), format_date()
├── resources/
│   ├── js/components/            # Vue components (optionally publishable)
│   └── lang/                     # Translation files (optionally publishable)
├── stubs/                        # Published to app on install
│   ├── app/                      # Controllers, Models, Domain, Providers, Enums
│   ├── config/                   # permission-resources.php, settings.php
│   ├── database/                 # Migrations, Seeders, Factories
│   ├── routes/                   # Web & API routes
│   ├── resources/js/             # Vue pages, Layouts, Composables, Theme
│   └── bootstrap/                # app.php, providers.php
└── config/
    └── starter-kit.php           # Package configuration

Application Structure (after install)

app/
├── Domain/                       # DDD business logic
│   ├── User/                     # Actions, DTOs, Queries, Events, Listeners
│   ├── Role/
│   ├── Auth/
│   ├── Setting/
│   ├── ActivityLog/
│   └── Shared/                   # Base classes (updated by package)
├── Http/
│   ├── Controllers/Admin/        # Admin panel controllers
│   ├── Controllers/Api/          # REST API controllers
│   └── Middleware/
├── Models/
├── Enums/
└── Providers/

Update Strategy

Using Package Components

Vue Components (without publishing)

Components are auto-resolved from the package. Use them in your Vue files:

<template>
    <SkForm :config="formConfig" />
    <SkDatatable :config="tableConfig" />
    <SkTabs :config="tabConfig" />
</template>

Translations

// From package namespace
__('starter-kit::admin.menu.dashboard')
__('starter-kit::message.created')

Base Classes

use Lvntr\StarterKit\Domain\Shared\Actions\BaseAction;
use Lvntr\StarterKit\Domain\Shared\DTOs\BaseDTO;
use Lvntr\StarterKit\Enums\PermissionEnum;
use Lvntr\StarterKit\Traits\HasActivityLogging;

License

PolyForm Noncommercial 1.0.0