glavweb/symfony-rest

The "Symfony Edition" distribution for REST API

Symfony REST Edition

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

For details on how to download and get started with Symfony, see the Installation chapter of the Symfony Documentation., _(*2)

1) Installing the REST Edition

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

Get the application using composer

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

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

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

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

php composer.phar create-project glavweb/symfony-rest path/to/application

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

Execute migrations:

php bin/console d:m:m -n

Execute fixtures:

php bin/console h:d:f:l -n

2) Checking your System Configuration

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

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

php app/check.php

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

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

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

3) Browsing the Demo Application

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

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

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

To see a admin dashboard, access the following page:, _(*15)

http://localhost/path/to/application/admin

User access:, _(*16)

login: admin
password: weloveglavweb

To see a API documentation, access the following page:, _(*17)

http://localhost/path/to/application/api/doc

Where you can test your API., _(*18)

What's inside?

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

• An AppBundle you can use to start coding;, _(*20)

• Twig as the only configured template engine;, _(*21)

• Doctrine ORM/DBAL;, _(*22)

• Swiftmailer;, _(*23)

• Annotations enabled for everything., _(*24)

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

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

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

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

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

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

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

• [MonologBundle][11] - Adds support for Monolog, a logging library, _(*32)

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

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

• [SensioGeneratorBundle][13] (in dev/test env) - Adds code generation capabilities, _(*35)

• DebugBundle (in dev/test env) - Adds Debug and VarDumper component integration, _(*36)

• [FOSRestBundle][16] - Adds rest functionality, _(*37)

• [NelmioApiDocBundle][17] - Add API documentation features, _(*38)

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

Enjoy!, _(*40)