❮ 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
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).
- Translated into tens of languages.
- Fast, simple and smart where appropriate.
Requirements
- Symfony 2.3+ applications (Silex not supported).
- Doctrine ORM entities (Doctrine ODM and Propel not supported).
- Entities with simple primary keys (composite keys not supported).
- All kinds of entity associations are supported.
- Entities using inheritance are not supported.
Documentation
Getting Started Guide
- Chapter 1 - Installation
- Chapter 2 - Your First Backend
- Chapter 3 - Backend Configuration
- Chapter 4 - Views and Actions
- Chapter 5 - Backend Design Customization
- Chapter 6 - About this Project
Advanced Tutorials
- Customizing Backend Actions
- Customizing AdminController
- Advanced Design Customization
- How to Translate the Backend
- How to Define Custom Actions
- How to Use a WYSIWYG Editor
- How to Upload Files and Images
- Tips and Tricks
- Configuration Reference
❮ 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.10.2/).
Demo Application
easy-admin-demo is a simple 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
php app/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
Customer
, Order
and Product
.
Creating the backend for those entities just require you to add the following
configuration in the app/config/config.yml
file:
# app/config/config.yml
easy_admin:
entities:
- AppBundle\Entity\Customer
- AppBundle\Entity\Order
- AppBundle\Entity\Product
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:
Creating a backend is that simple because EasyAdmin doesn't generate any code. All resources are served on-the-fly to ensure an exceptional developer experience.
Without any further configuration, EasyAdmin guesses the best settings to make your admin backend look "good enough". This may be acceptable for simple backends and rapid prototypes, but most of the times, you need to customize some parts of the backend. Keep reading the rest of the documentation to learn how to do it.
License
This software is published under the MIT License