ucsf-ckm/symfony-emberjs-edition

The "Symfony EmberJS Edition" distribution

Symfony EmberJS Edition

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

It owes a lot to: FOSRestBundle, _(*2)

http://williamdurand.fr/2012/08/02/rest-apis-with-symfony2-the-right-way/, _(*3)

http://welcometothebundle.com/symfony2-rest-api-the-best-2013-way/, _(*4)

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

1) Installing Dependencies

npm install -g bower npm install -g ember-precompile, _(*6)

2) Installing the EmberJS Edition

When it comes to installing the Symfony EmberJS Edition, you have the following options., _(*7)

Use Composer (recommended)

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

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

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

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

php composer.phar create-project ucsf-ckm/symfony-emberjs-edition path/to/install

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

Download an Archive File

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

If you downloaded an archive "without vendors", you also need to install all the necessary dependencies. Download composer (see above) and run the following command:, _(*13)

php composer.phar install

3) Checking your System Configuration

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

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

php app/check.php

The script returns a status code of 0 if all mandatory requirements are met, 1 otherwise., _(*16)

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

http://localhost/path-to-project/web/config.php

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

4) Browsing the Demo Application

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

From the config.php page click on the "Configure your Symfony Application online" link of the config.php page., _(*20)

Setup your database connection - use sqlite for a fast demo., _(*21)

Create the database schema and add some sample data:, _(*22)

php app/console doctrine:schema:create --env=dev
php app/console doctrine:fixtures:load --env=dev

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

web/app_dev.php/

To browse your new API documentation visit:, _(*24)

web/app_dev.php/api/doc/

And to see the API in action, _(*25)

web/app_dev.php/api/v1/products
web/app_dev.php/api/v1/products/1.json
web/app_dev.php/api/v1/products/1.xml

What's inside?

The Symfony EmberJS Edition is configured with the following defaults:, _(*26)

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

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

• Swiftmailer is configured;, _(*29)

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

• FOSRest is configured, _(*31)

• Bower is configured, _(*32)

• Assetic with ember-precompile is configured, _(*33)

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

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

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

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

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

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

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

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

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

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

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

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

• FOSRestBundle - Adds suport for rest API, _(*46)

• NelmioApiDocBundle - Generates API Docs, _(*47)

• FOSJsRoutingBundle - Exposes routes in JavaScript, _(*48)

• [SpBowerBundle][17] - Downloads bower dependencies, _(*49)

• AcmeApiBundle (in dev/test env) - A demo bundle with example code for building an EmberJS friendly API, _(*50)

• AcmeEmberBundle (in dev/test env) - A demo bundle with example code for organizing and EmberJS application, _(*51)

All libraries and bundles included in the Symfony EmberJS Edition are released under the MIT or BSD license., _(*52)

Enjoy!, _(*53)