README

![PHP](https://img.shields.io/badge/PHP-=8.2-777BB4?logo=php&logoColor=white>)

Modern Symfony admin bundle powered by LiveComponents for managing Doctrine entities with extensive customization capabilities.

Documentation

Configuration Guide - Complete guide to configuring entities with the #[Admin] attribute
Template Overrides Guide - How to customize the admin interface appearance

Features

🚀 LiveComponent-Ready: Built for Symfony UX LiveComponents
🎨 Template Override System: Hierarchical template resolution for easy customization
🔧 Type-Based Rendering: Smart property rendering based on Doctrine types
📝 Attribute-Driven: Modern PHP 8+ attribute configuration
🔍 Filters & Search: Built-in filtering and search capabilities
⚡ Batch Operations: Select and act on multiple entities
📊 Dashboard & Menu: Configurable admin dashboard and navigation

Installation

composer require kachnitel/admin-bundle

Enable the bundle in config/bundles.php:

return [
    // ...
    Kachnitel\AdminBundle\KachnitelAdminBundle::class => ['all' => true],
];

Quick Start

1. Configure the Bundle

Create config/packages/kachnitel_admin.yaml:

kachnitel_admin:
    entity_namespace: 'App\Entity\'
    form_namespace: 'App\Form\'
    route_prefix: 'admin'
    base_layout: 'layout.html.twig'  # Optional: your app's base layout

2. Add Routes

In config/routes.yaml:

kachnitel_admin:
    resource: '@KachnitelAdminBundle/config/routes.yaml'
    prefix: /admin

3. Mark Entities with #[Admin] Attribute

Add the #[Admin] attribute to any Doctrine entity:

use Kachnitel\AdminBundle\Attribute\Admin;

#[Admin(label: 'Products', icon: 'inventory')]
class Product
{
    // ...
}

That's it! The entity will now appear in the admin dashboard.

For advanced configuration (columns, permissions, pagination, etc.), see the Configuration Guide.

For template customization, see the Template Overrides Guide.

Requirements

PHP 8.2 or higher
Symfony 6.4 or 7.0+
Doctrine ORM 2.0 or 3.0+

Development

Running Tests

# Run all tests
composer test

# Run tests with coverage (requires Xdebug)
composer coverage

# View HTML coverage report
open .coverage/index.html

Code Quality

# Run PHPStan (level 6)
composer phpstan

# Update metrics and badges
composer metrics

Pre-commit Hook

The project includes a pre-commit hook that automatically updates metrics before each commit:

# Install git hooks
composer install-hooks

# To skip hook temporarily
git commit --no-verify

The hook will:

Run tests with coverage
Run PHPStan analysis
Update README badges
Fail the commit if tests or PHPStan fail

Metrics

Project metrics are auto-generated and stored in .metrics/:

badges.md - Badge markdown for README
metrics.json - Machine-readable metrics
Coverage reports in .coverage/ (gitignored)

Creating Releases

The project uses Conventional Commits for automated changelog generation:

# Create a new release (patch/minor/major/beta/rc/alpha)
composer release patch   # 1.0.0 -> 1.0.1
composer release minor   # 1.0.0 -> 1.1.0
composer release major   # 1.0.0 -> 2.0.0
composer release beta    # 1.0.0 -> 1.0.1-beta.1

# After reviewing, push to remote
git push origin master --tags

The release script will:

Generate/update CHANGELOG.md from commit messages
Create a new version tag
Commit the changes

Commit Message Format:

<type>(<scope>): <subject>

<body>

<footer>

Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore

Examples:

feat: Add user authentication
fix: Resolve pagination edge case
docs: Update installation guide

License

MIT License - see LICENSE file for details.

kachnitel / admin-bundle

Maintainers

Details