The "UCS Bundles Standard Edition" distribution
Welcome to the UCS Standard Edition - a fully-functional Symfony2 Backoffice application that you can use as the skeleton for your new applications.
This document contains information on how to download, install, and start using UCS. For a more detailed explanation, see the Installation chapter of the UCS Standard Edition Bundles Documentation.
When it comes to installing the UCS Standard Edition, you have the following options.
As Symfony, UCS uses Composer to manage its dependencies, the recommended way to create a new project is to use it.
If you don't have Composer yet, download it following the instructions on http://getcomposer.org/ or just run the following command:
curl -s http://getcomposer.org/installer | php
Then, use the
create-project command to generate a new UCS application:
php composer.phar create-project ucs/standard-edition path/to/install
Composer will install UCS and all its dependencies under the
To quickly test UCS, you can also download an archive of the Standard Edition and unpack it somewhere under your web server root directory.
Download composer (see above) and run the following command:
php composer.phar install
Before starting coding an using UCS, make sure that your local system is properly configured for Symfony.
check.php script from the command line:
The script returns a status code of
0 if all mandatory requirements are met,
config.php script from a browser:
If you get any warnings or recommendations, fix them before moving on.
Before launching your new UCS application you should create your database to
ensure that all base tables have been set up for your project. You should
have answered during the installation phase to some important questions about
the database connexion parameters. If not you will have to edit your
UCS uses doctrine and is not supporting Propel at the moment. Create the database with Doctrine :
php app/console doctrine:database:create
Create the schema:
php app/console doctrine:schema:create
Load Default Fixtures from
php app/console doctrine:fixtures:load --fixtures=./app/DataFixtures/ORM/loadUserData.php
Feel free to change the default user name and email in the fixtures file. If not the
default login will be:
admin and the default password:
Congratulations! You're now ready to use UCS.
config.php page, click the "Bypass configuration and go to the
Welcome page" link to go to UCS login page.
By default, UCS is a full secured application which means that you cannot access the welcome page without being logged in. UCS Bundles do not need the UCS Security Component to work.
This distribution is meant to be the starting point for your UCS applications, but it also contains some sample code that you can learn from and play with.
A great way to start learning UCS is via the Documentation, which will take you through all the basic features of UCS.
Once you're feeling good, you can move onto reading the official UCS Book.
A default bundle,
UCSDemoBundle, shows you UCS in action. After
playing with it, you can remove it by following these steps:
remove the routing entry referencing UCSDemoBundle in
remove the UCSDemoBundle from the registered bundles in
The UCS Standard Edition is configured with the following defaults:
Twig is the only configured template engine;
Doctrine ORM/DBAL is configured;
Swiftmailer is configured;
Annotations for everything are enabled.
It comes pre-configured with the following bundles:
UCSRichUIBundle - The core UCS Application Management Bundle
UCSBackOfficeBundle - Adds several enhancements, like twig templates to help you design faster
UCSSearchBundle - Adds easy search capabilities to your UCS Application
UCSMailerBundle - Adds support for different mailers in your Symfony2 application
UCSUtilsBundle - Brings additional utility classes and tools to your UCS Application
All libraries and bundles included in the UCS Standard Edition are released under the MIT license.