https://github.com/gimler/symfony-rest-edition
Fork from symfony-standard edition with additional rest features.
https://github.com/gimler/symfony-rest-edition
composer php symfony symfony-application
Last synced: 30 days ago
JSON representation
Fork from symfony-standard edition with additional rest features.
- Host: GitHub
- URL: https://github.com/gimler/symfony-rest-edition
- Owner: gimler
- License: mit
- Archived: true
- Created: 2013-04-08T09:15:41.000Z (over 12 years ago)
- Default Branch: 2.7
- Last Pushed: 2017-02-04T20:42:24.000Z (over 8 years ago)
- Last Synced: 2024-04-16T07:24:09.242Z (over 1 year ago)
- Topics: composer, php, symfony, symfony-application
- Language: PHP
- Size: 930 KB
- Stars: 635
- Watchers: 46
- Forks: 129
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rest - Symfony REST Edition - Start with a Symfony2 application with all REST-friendly bundles pre-configured. (Servers / PHP)
README
Symfony REST Edition
========================
[](https://travis-ci.org/gimler/symfony-rest-edition) [](https://packagist.org/packages/gimler/symfony-rest-edition)
Welcome to the Symfony REST Edition - a fully-functional Symfony2
application that you can use as the skeleton for your new applications.
This document contains information on how to download, install, and start
using Symfony. For a more detailed explanation, see the [Installation][1]
chapter of the Symfony Documentation.
1) Installing the REST Edition
----------------------------------
When it comes to installing the Symfony REST Edition, you have the
following options.
### Use Composer (*recommended*)
As Symfony uses [Composer][2] 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 Symfony application:
php composer.phar create-project gimler/symfony-rest-edition --stability=dev path/to/install
Composer will install Symfony and all its dependencies under the
`path/to/install` directory.
### Download an Archive File
To quickly test Symfony, you can also download an [archive][3] of the Standard
Edition and unpack it somewhere under your web server root directory.
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:
php composer.phar install
2) Checking your System Configuration
-------------------------------------
Before starting coding, make sure that your local system is properly
configured for Symfony.
Execute the `check.php` script from the command line:
php app/check.php
Access the `config.php` script from a browser:
http://localhost/path/to/symfony/app/web/config.php
If you get any warnings or recommendations, fix them before moving on.
3) Browsing the Demo Application
--------------------------------
Congratulations! You're now ready to use Symfony.
From the `config.php` page, click the "Bypass configuration and go to the
Welcome page" link to load up your first Symfony page.
You can also use a web-based configurator by clicking on the "Configure your
Symfony Application online" link of the `config.php` page.
To see a real-live Symfony page in action, access the following page:
web/app_dev.php/notes
Using the console after installing httpie.org or some other http client
you can run some commands to test the API as well:
http "http://symfony-rest-edition.lo/app_dev.php/notes" --json -a restapi:secretpw
http POST "http://symfony-rest-edition.lo/app_dev.php/notes" --json -a restapi:secretpw < note.json
http "http://symfony-rest-edition.lo/app_dev.php/notes/0" --json -a restapi:secretpw
http "http://symfony-rest-edition.lo/app_dev.php/notes/0" "Accept:application/json;version=1.0" -a restapi:secretpw
http DELETE "http://symfony-rest-edition.lo/app_dev.php/notes/0" --json -a restapi:secretpw
http PUT "http://symfony-rest-edition.lo/app_dev.php/notes/0" --json -a restapi:secretpw < note.json
http PUT "http://symfony-rest-edition.lo/app_dev.php/notes/1" --json -a restapi:secretpw < note.json
http PUT "http://symfony-rest-edition.lo/app_dev.php/notes/2" --json -a restapi:secretpw < note.json
http PUT "http://symfony-rest-edition.lo/app_dev.php/notes/3" --json -a restapi:secretpw < note.json
http "http://symfony-rest-edition.lo/app_dev.php/notes?offset=1&limit=1" --json -a restapi:secretpw
To run the tests install PHPUnit 3.7+ and call:
phpunit -c app/
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.
A great way to start learning Symfony is via the [Quick Tour][4], which will
take you through all the basic features of Symfony2.
Once you're feeling good, you can move onto reading the official
[Symfony2 book][5].
A default bundle, `AppBundle`, shows you Symfony2 in action. After
playing with it, you can remove it by following these steps:
* delete the `src/AppBundle` directory;
* remove the routing entries referencing AcmeBundle in
`app/config/routing_dev.yml`;
* remove the AcmeBundle from the registered bundles in `app/AppKernel.php`;
* remove the `web/bundles/acmedemo` directory;
* 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.
What's inside?
---------------
The Symfony REST Edition is configured with the following defaults:
* Twig is the only configured template engine;
* Translations are activated
* Doctrine ORM/DBAL is configured;
* Swiftmailer is configured;
* Annotations for everything are enabled.
It comes pre-configured with the following bundles:
* **FrameworkBundle** - The core Symfony framework bundle
* [**SensioFrameworkExtraBundle**][6] - Adds several enhancements, including
template and routing annotation capability
* [**DoctrineBundle**][7] - Adds support for the Doctrine ORM
* [**TwigBundle**][8] - Adds support for the Twig templating engine
* [**SecurityBundle**][9] - Adds security by integrating Symfony's security
component
* [**SwiftmailerBundle**][10] - Adds support for Swiftmailer, a library for
sending emails
* [**MonologBundle**][11] - Adds support for Monolog, a logging library
* [**AsseticBundle**][12] - Adds support for Assetic, an asset processing
library
* **WebProfilerBundle** (in dev/test env) - Adds profiling functionality and
the web debug toolbar
* **SensioDistributionBundle** (in dev/test env) - Adds functionality for
configuring and working with Symfony distributions
* [**SensioGeneratorBundle**][15] (in dev/test env) - Adds code generation
capabilities
* **AcmeDemoBundle** (in dev/test env) - A demo bundle with some example
code
* [**FOSRestBundle**][16] - Adds rest functionality
* [**FOSHttpCacheBundle**][21] - This bundle offers tools to improve HTTP caching with Symfony2
* [**NelmioApiDocBundle**][17] - Add API documentation features
* [**BazingaHateoasBundle**][18] - Adds HATEOAS support
* [**HautelookTemplatedUriBundle**][19] - Adds Templated URIs (RFC 6570) support
* [**BazingaRestExtraBundle**][20]
Enjoy!
[1]: http://symfony.com/doc/2.7/book/installation.html
[2]: http://getcomposer.org/
[3]: https://github.com/gimler/symfony-rest-edition/archive/master.zip
[4]: http://symfony.com/doc/2.7/quick_tour/the_big_picture.html
[5]: http://symfony.com/doc/2.7/index.html
[6]: http://symfony.com/doc/2.7/bundles/SensioFrameworkExtraBundle/index.html
[7]: http://symfony.com/doc/2.7/book/doctrine.html
[8]: http://symfony.com/doc/2.7/book/templating.html
[9]: http://symfony.com/doc/2.7/book/security.html
[10]: http://symfony.com/doc/2.7/cookbook/email.html
[11]: http://symfony.com/doc/2.7/cookbook/logging/monolog.html
[12]: http://symfony.com/doc/2.7/cookbook/assetic/asset_management.html
[15]: http://symfony.com/doc/2.7/bundles/SensioGeneratorBundle/index.html
[16]: https://github.com/FriendsOfSymfony/FOSRestBundle
[17]: https://github.com/nelmio/NelmioApiDocBundle
[18]: https://github.com/willdurand/BazingaHateoasBundle
[19]: https://github.com/hautelook/TemplatedUriBundle
[20]: https://github.com/willdurand/BazingaRestExtraBundle
[21]: https://github.com/FriendsOfSymfony/FOSHttpCacheBundle/