README.md

❮ NOTE ❯ This bundle releases new versions on a regular basis. Make sure to update your dependencies frequently to get the latest version. Check out the changelog to learn about the new features and read the UPGRADE guide.

---

EasyAdmin

^{SUPPORTS SYMFONY 2.x and 3.x}

EasyAdmin lets you create administration backends for Symfony applications with unprecedented simplicity.

Features

• CRUD operations on Doctrine entities (create, edit, list, delete).
• Full-text search, pagination and column sorting.
• Fully responsive design (smartphones, tablets and desktops).
• Supports Symfony 2.x and 3.x.
• Translated into tens of languages.
• Fast, simple and smart where appropriate.

Requirements

• Symfony 2.3+ or 3.x applications (Silex not supported).
• Doctrine ORM entities (Doctrine ODM and Propel not supported).
• Entities with composite keys or using inheritance are not supported.

Documentation

Getting Started Guide

The Getting Started Guide explains how to install the bundle and how to create your first backend. This guide is a must- read before using EasyAdmin.

The Book

• Chapter 1 - Basic configuration
• Chapter 2 - Design configuration
• Chapter 3 - list, search and show views configuration
• Chapter 4 - edit and new views configuration
• Chapter 5 - Actions configuration
• Chapter 6 - Menu configuration
• Chapter 7 - Creating complex and dynamic backends
• Chapter 8 - About this project
• Appendix - Full configuration reference

Tutorials

• How to translate the backend
• How to define custom actions
• How to define custom options for entity properties
• How to manage configuration for complex backends
• Tips and tricks

Third-party bundles/services integrations

• How to upload files and images with VichUploaderBundle
• How to integrate FOSUserBundle to manage users
• How to use a WYSIWYG editor with IvoryCKEditorBundle
• How To integrate FOSRestBundle and EasyAdmin

❮ NOTE ❯ you are reading the documentation of the bundle's development version. You can also [read the documentation of the latest stable version ➜] (https://github.com/javiereguiluz/EasyAdminBundle/tree/v1.15.1/).

Demo Application

easy-admin-demo is a complete Symfony application created to showcase EasyAdmin features.

Installation

Step 1: Download the Bundle

$ composer require javiereguiluz/easyadmin-bundle

This command requires you to have Composer installed globally, as explained in the Composer documentation.

Step 2: Enable the Bundle

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new JavierEguiluz\Bundle\EasyAdminBundle\EasyAdminBundle(),
        );
    }

    // ...
}

Step 3: Load the Routes of the Bundle

# app/config/routing.yml
easy_admin_bundle:
    resource: "@EasyAdminBundle/Controller/"
    type:     annotation
    prefix:   /admin

# ...

Step 4: Prepare the Web Assets of the Bundle

# Symfony 2
php app/console assets:install --symlink

# Symfony 3
php bin/console assets:install --symlink

That's it! Now everything is ready to create your first admin backend.

Your First Backend

Creating your first backend will take you less than 30 seconds. Let's suppose that your Symfony application defines three Doctrine ORM entities called Product, Category and User.

Open the app/config/config.yml file and add the following configuration:

# app/config/config.yml
easy_admin:
    entities:
        - AppBundle\Entity\Product
        - AppBundle\Entity\Category
        - AppBundle\Entity\User

Congratulations! You've just created your first fully-featured backend! Browse the /admin URL in your Symfony application and you'll get access to the admin backend:

Keep reading the rest of the documentation to learn how to create complex backends.

License

This software is published under the MIT License