jmather/symfony-sonata-distribution

The "Symfony Sonata Edition" distribution

Symfony Sonata Distribution

Welcome to the Symfony Sonata Distribution - a fully-functional Symfony2 Sonata application that you can use as the skeleton for your new application., _(*1)

This distribution exists to save you from repeating all the steps needed to create a basic Sonata app., _(*2)

This document contains information on how to download, install, and start using Symfony with Sonata. For a more detailed explanation, see the Installation chapter of the Symfony Documentation., _(*3)

NOTE: For older Symfony versions use the corresponding branch., _(*4)

1) Installing the Sonata Distribution

When it comes to installing the Symfony Sonata Distribution, you have the following options., _(*5)

Use Composer (recommended)

As Symfony uses Composer to manage its dependencies, the recommended way to create a new project is to use it., _(*6)

If you don't have Composer yet, download it following the instructions on http://getcomposer.org/ or just run the following command:, _(*7)

curl -s http://getcomposer.org/installer | php

Then, use the create-project command to generate a new Symfony Sonata application:, _(*8)

php composer.phar create-project -s dev jmather/symfony-sonata-distribution path/to/install

Composer will install Symfony and all its dependencies under the path/to/install directory., _(*9)

Download an Archive File

To quickly test Symfony Sonata, you can also download an archive of the Sonata Distribution and unpack it somewhere under your web server root directory., _(*10)

You also need to install all the necessary dependencies. Download composer (see above) and run the following command:, _(*11)

php composer.phar install

2) Checking your System Configuration

Before starting coding, make sure that your local system is properly configured for Symfony., _(*12)

Execute the check.php script from the command line:, _(*13)

php app/check.php

Access the config.php script from a browser:, _(*14)

http://localhost/path/to/symfony/app/web/config.php

If you get any warnings or recommendations, fix them before moving on., _(*15)

3) Set up, initialize and browse the app

Initializing the DB

Before you can run the server and log in to Sonata you need to create the tables first., _(*16)

./app/console doctrine:schema:create

Create the users

You can either create a handful of users like this (one of the usernames is 'superadmin' with password 'test'), _(*17)

./app/console doctrine:fixtures:load

Or you can manually create a user yourself, _(*18)

./app/console fos:user:create username emai@example.com password
./app/console fos:user:promote username ROLE_SONATA_ADMIN

Install assets:

./app/console assets:install --symlink --relative web

Start the server:

Congratulations! You're now ready to use Symfony Sonata, _(*19)

./app/console server:run

Login

Now you can login as user 'superadmin' with password 'test' at, _(*20)

http://localhost:8000/admin

Warning

Currently .htaccess is configured to use app_dev.php but not app.php (production - no debug). When you launch your application don't forget to use app.php., _(*21)

Browsing the Demo Application

From the config.php page, click the "Bypass configuration and go to the Welcome page" link to load up your first Symfony page., _(*22)

You can also use a web-based configurator by clicking on the "Configure your Symfony Application online" link of the config.php page., _(*23)

To see a real-live Symfony page in action, access the following page:, _(*24)

web/app_dev.php/demo/hello/Fabien

4) Getting started with Symfony

This distribution is meant to be the starting point for your Symfony applications, but it also contains some sample code that you can learn from and play with., _(*25)

A great way to start learning Symfony is via the Quick Tour, which will take you through all the basic features of Symfony2., _(*26)

Once you're feeling good, you can move onto reading the official Symfony2 book., _(*27)

A default bundle, AcmeDemoBundle, shows you Symfony2 in action. After playing with it, you can remove it by following these steps:, _(*28)

• delete the src/Acme directory;, _(*29)

• remove the routing entries referencing AcmeBundle in app/config/routing_dev.yml;, _(*30)

• remove the AcmeBundle from the registered bundles in app/AppKernel.php;, _(*31)

• remove the web/bundles/acmedemo directory;, _(*32)

• remove the security.providers, security.firewalls.login and security.firewalls.secured_area entries in the security.yml file or tweak the security configuration to fit your needs., _(*33)

What's inside Symfony Sonata Distribution?

The Symfony Sonata Distribution is based on the Symfony Standard Edition. Additionally the following bundles are used to configure a fully functional Sonata application:, _(*34)

• SonataCoreBundle - The foundation on which the Sonata bundles rest, _(*35)

• SonataAdminBundle - The main bundle needed to create the admin interface, _(*36)

• SonataDoctrineORMAdminBundle - Integrates Doctrine ORM project with the admin bundle, _(*37)

• FOSUserBundle - Provides user management, _(*38)

• SonataUserBundle - Integrates the FOSUserBundle and adds some features, _(*39)

• [SonataBlockBundle][21] - This bundle provides a block management solution, _(*40)

There are some more bundles necessary to run the application so take a look at the composer.json file., _(*41)

What's inside Symfony Standard Edition

The Symfony Standard Edition is configured with the following defaults:, _(*42)

• Twig is the only configured template engine;, _(*43)

• Doctrine ORM/DBAL is configured;, _(*44)

• Swiftmailer is configured;, _(*45)

• Annotations for everything are enabled., _(*46)

It comes pre-configured with the following bundles:, _(*47)

• FrameworkBundle - The core Symfony framework bundle, _(*48)

• SensioFrameworkExtraBundle - Adds several enhancements, including template and routing annotation capability, _(*49)

• DoctrineBundle - Adds support for the Doctrine ORM, _(*50)

• TwigBundle - Adds support for the Twig templating engine, _(*51)

• SecurityBundle - Adds security by integrating Symfony's security component, _(*52)

• SwiftmailerBundle - Adds support for Swiftmailer, a library for sending emails, _(*53)

• MonologBundle - Adds support for Monolog, a logging library, _(*54)

• AsseticBundle - Adds support for Assetic, an asset processing library, _(*55)

• JMSSecurityExtraBundle - Allows security to be added via annotations, _(*56)

• JMSDiExtraBundle - Adds more powerful dependency injection features, _(*57)

• WebProfilerBundle (in dev/test env) - Adds profiling functionality and the web debug toolbar, _(*58)

• SensioDistributionBundle (in dev/test env) - Adds functionality for configuring and working with Symfony distributions, _(*59)

• SensioGeneratorBundle (in dev/test env) - Adds code generation capabilities, _(*60)

• AcmeDemoBundle (in dev/test env) - A demo bundle with some example code, _(*61)

Enjoy!, _(*62)